COcoupa
User

Query users

Query users

get/users

Request

  • Base URL
    https://r38.coupadev.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://r38.coupadev.com/oauth2/authorizations/new
      Token URLhttps://r38.coupadev.com/oauth2/token
    • or OAuth 2
      Client credentials
      Token URLhttps://r38.coupadev.com/oauth2/access_tokens
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger
offsetinteger
order_bystring
dir'asc' | 'desc'
return_object'limited' | 'shallow' | 'none'
filterstring

Response

User objects

account-security-typeinteger

account_security_type

activeboolean

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.

active?boolean

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.

aic-userboolean

Does the user have an AI Classification License?

aic-user?boolean

Does the user have an AI Classification License?

allow-employee-payment-account-creationboolean

Allow the user to create an Employee Payment Account, regardless of the Employee Payment Channel.

allow-user-to-upload-invoice-from-mobileboolean

Allow user to upload Invoice images from Coupa Mobile to Invoice Inbox

allowed-invoice-inboxesstring text

Invoice inboxes that mobile user allowed to send invoice to

analytics-userboolean

Does the user have an Analytics License?

analytics-user?boolean

Does the user have an Analytics License?

api-userboolean

Is an API User?

api-user?boolean

Is an API User?

authentication-methodstring string(255)

What Authentication Method will be used (Coupa_Credentials, LDAP, SAML)?

avatar-thumb-urlstring string

Avatar url

business-functionstring string(255)

The employee's main job role in your company, e.g. Sales, Executive, Administrative, Managerial, etc.

business-group-security-typeinteger

business_group_security_type

ccw-userboolean

Does the user have a Contingent Workforce License?

ccw-user?boolean

Does the user have a Contingent Workforce License?

clm-advanced-userboolean

Does the user have a Contract Lifecycle Management Advanced License?

clm-advanced-user?boolean

Does the user have a Contract Lifecycle Management Advanced License?

contracts-userboolean

Does the user have a Contracts License?

contracts-user?boolean

Does the user have a Contracts License?

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

default-localestring string(10)

Default locale

eligible-for-virtual-cardsboolean

Is the user eligible to manage their virtual cards?

emailstring string(255) required

email

employee-numberstring string(255)

employee number

employee-payment-channelstring string(255)

Determine how expenses will be paid to the employee. 'ERP' per default and can be switched to 'CoupaPay' if instance allows it.

expense-userboolean

Does the user have a Expense License?

expense-user?boolean

Does the user have a Expense License?

firstnamestring string(40) required

first name

fullnamestring string(255)

full name

generate-password-and-notify'Yes' | 'No' string

Set to Yes if you want the system to invite the user to the system and have them set up their password

idinteger

Coupa unique identifier

inventory-userboolean

Does the user have a Inventory License?

inventory-user?boolean

Does the user have a Inventory License?

invoicing-userboolean

Does the user have a Invoicing License?

invoicing-user?boolean

Does the user have a Invoicing License?

lastnamestring string(40) required

last name

loginstring string(255) required

login

mention-namestring string(255)

Mention Name

middlenamestring string(255)

middle name

msp-userboolean

Boolean flag to tell if the user is of MSP type

passwordstring string

Changed password

purchasing-userboolean

Does the user have a Purchasing License?

purchasing-user?boolean

Does the user have a Purchasing License?

risk-assess-userboolean

Does the user have a Risk Assess License?

salesforce-enabledboolean

salesforce_enabled

salesforce-idstring string(255) required

salesforce_id

seniority-levelstring string(255)

The employee's job grade or band in your company's hierarchy.

sourcing-userboolean

Does the user have a Sourcing License?

sourcing-user?boolean

Does the user have a Sourcing License?

spend-guard-userboolean

Does the user have a Spend Guard License?

spend-guard-user?boolean

Does the user have a Spend Guard License?

sso-identifierstring string(255)

User's Single Sign-on ID (SSO ID)

supplier-idinteger

Supplier Id

supplier-userboolean

Supplier User

supply-chain-userboolean

Does the user have a Supply Chain License?

supply-chain-user?boolean

Does the user have a Supply Chain License?

support-userboolean

Support User

travel-userboolean

Does the user have a Travel License?

travel-user?boolean

Does the user have a Travel License?

treasury-userboolean

Does the user have a Treasury License?

treasury-user?boolean

Does the user have a Treasury License?

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

Changes

No recorded changes to this operation across all 1 revision of this API.