v1

latestOpenAPI 3.1.02026-08-0651316.6 KB
API User

Get API users for a TMC

Retrieves the list of all active API users associated with the caller's TMC.

Use this endpoint to:

  • Audit existing API users and their clientIds under a TMC.
  • Look up the clientId for a specific API user before rotating its client secret or revoking access.

Notes:

  • This endpoint supports pagination using limit and offset query parameters.
  • The response includes only the clientId for each user. The clientSecret is never returned.
  • Returns only the API users belonging to the caller's contracting TMC.
  • Only a TMC admin can use this endpoint.
get/v2/api-users

Query parameters

limitinteger

Number of results to return

offsetinteger

Offset for pagination

Response

OK

totalCountinteger

Total count of api users

Example response

{
  "apiUsers": [
    {
      "clientId": "1ddj3hs95to28iag7m4hl9lv2"
    }
  ],
  "totalCount": 25
}