Skip to main content



Coupa Success Portal

Users API

The users API allows you to create, update, or query users. This ranges from basic demographics, to managing passwords, to managing the groups and approval permissions they may have.

The URL to access users is: https://<instance>/api/users

See Integration Best Practices for more info.


The Users API allows you to:

Verb Path Action Description
PUT /api/users/:id/avatar avatar Avatar
POST /api/users create Create user
GET /api/users index Query users
GET /api/users/:id show Show user
PATCH /api/users/:id update Update user
PUT /api/users/:id update Update user


The following elements are available for the Users API:

Element Description Required Field? Unique? Allowable Value Api_In Field? Api_Out Field? Data Type
account-groups account_groups       yes yes
account-security-type account_security_type       yes yes integer
active A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.       yes    
active? active?         yes true
api-user? api_user?         yes boolean
approval-groups approval_groups       yes yes
approval-limit-attributes approval_limit_attributes       yes    
authentication-method What Authentication Method will be used (Coupa_Credentials, LDAP, SAML)?       yes yes string
avatar-thumb-url Avatar url         yes  
business-group-security-type business_group_security_type     0, 1 yes yes integer
business-groups business_groups       yes yes ContentGroup
can-delegate-expenses-to can_delegate_expenses_to         yes User
can-expense-for can_expense_for         yes User
change-password change_password       yes    
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User
default-account default_account       yes yes Account
default-account-type default_account_type       yes yes AccountType
default-address default_address       yes yes Address
default-currency default_currency       yes yes Currency
default-locale Default locale    

"en-BORK", "vi", "uk", "en-SG", "en-US", "en-IND", "da-DK", "en-au-ocker", "ca", "ca-CAT", "en-UG", "nb-NO", "en-NZ", "fi-FI", "nep", "he", "sk", "fa", "en-BORK", "vi", "uk", "en-SG", "en-US", "en-IND", "da-DK", "en-au-ocker", "ca", "ca-CAT", "en-UG", "nb-NO", "en-NZ", "fi-FI", "nep", "he", "sk", "fa"

yes yes string
department department       yes yes Department
edit-invoice-on-quick-entry edit_invoice_on_quick_entry       yes yes boolean
email email yes yes   yes yes string(255)
employee-number employee number   yes   yes yes string(255)
expense-approval-limit expense_approval_limit         yes
expense-approval-limit-attributes expense_approval_limit_attributes       yes    
expense-self-approval-limit expense_self_approval_limit         yes
expense-self-approval-limit-attributes expense_self_approval_limit_attributes       yes    
expense-user Does the user have an Expense License?       yes   boolean
expense-user? expense_user?         yes boolean
firstname first name yes     yes yes string(40)
fullname full name         yes string
id Coupa unique identifier         yes integer
inventory-organizations inventory_organizations       yes yes
inventory-user inventory_user       yes   boolean
inventory-user? inventory_user?         yes boolean
invoice-approval-limit invoice_approval_limit         yes
invoice-approval-limit-attributes invoice_approval_limit_attributes       yes    
invoice-self-approval-limit-attributes invoice_self_approval_limit_attributes       yes    
lastname last name yes     yes yes string(40)
login login yes yes   yes yes string(255)
mention-name Mention Name   yes   yes yes string(255)
parent parent       yes yes User
pcard pcard       yes yes
phone-mobile phone mobile       yes yes
phone-work phone work       yes yes
purchasing-user Does the user have a Purchasing License?       yes   boolean
purchasing-user? purchasing_user?         yes boolean
requisition-approval-limit requisition_approval_limit         yes
requisition-approval-limit-attributes requisition_approval_limit_attributes       yes    
requisition-self-approval-limit requisition_self_approval_limit         yes
requisition-self-approval-limit-attributes requisition_self_approval_limit_attributes       yes    
reset-password reset_password       yes    
roles roles       yes yes
salesforce-enabled salesforce_enabled       yes   boolean
salesforce-id salesforce_id yes     yes yes string
self-approval-limit-attributes self_approval_limit_attributes       yes    
sourcing-user sourcing_user       yes   boolean
sourcing-user? sourcing_user?         yes boolean
sso-identifier User's Single Sign-on ID (SSO ID)       yes yes string
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User
working-warehouses working_warehouses       yes yes
  • Was this article helpful?