Query user

Request

This endpoint queries user of given company based on given identifier like email or external ID. In case includeInactive is true, inactive users are also included in the response.

Security

Bearer

Query

companyIdstring, (uuid)

Identifier for company to search user for. Please specify one of the companyId or tmcId.

Example:companyId=4974a66b-7493-4f41-908c-58ba81093947

tmcIdstring, (uuid)

Identifier for TMC to search user for. Please specify one of the companyId or tmcId.

Example:tmcId=b83e9704-2e8e-4256-90bf-2e59c1bcf9f2

emailstring, (email)

Email ID of the user.

Example:email=user@example.com

externalIdstring

The partner-assigned user identifier.

Example:externalId=123456

employeeIdstring

Employee ID of the user.

Example:employeeId=EMP123456

includeInactiveboolean

If true, include inactive users in the response.

Default:false

Example:includeInactive=true

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users?companyId=4974a66b-7493-4f41-908c-58ba81093947&tmcId=b83e9704-2e8e-4256-90bf-2e59c1bcf9f2&email=user%40example.com&externalId=123456&employeeId=EMP123456&includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

lengthinteger, (int32)

elementsArray of objects(UserSummary)

List of references containing id and name.

Response

{
  "length": 0,
  "elements": [
    { … }
  ]
}