Sign in

v1

latestOpenAPI 3.1.02026-08-062713899.5 KB
Users

Query user

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.

get/v2/users

Query parameters

companyIdstring uuid

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

tmcIdstring uuid

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

emailstring email

Email ID of the user.

externalIdstring

The partner-assigned user identifier.

employeeIdstring

Employee ID of the user.

includeInactiveboolean

If true, include inactive users in the response.

Response

OK

lengthinteger

Example response

{
  "elements": [
    {
      "externalId": "user-1",
      "persona": "EMPLOYEE"
    }
  ]
}