keys

List End Users

Changed on

List the end users of a service key, oldest first.

End users belong to the key's user, so every service key of one user lists the same end users. A deleted end user is not listed. external_id reads one end user by any id, one containing '/' included, as a list of zero or one.

get/api/v1/keys/{key_id}/end-users

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

key_idstring required

Query parameters

skipinteger
limitinteger
budget_idstring nullable

Only end users on this budget.

blockedboolean nullable

Only end users that are, or are not, blocked.

external_idstring nullable

Only the end user the service names with this user value: zero or one.

include_totalboolean

Also count every matching end user, in the Otari-Total-Count response header.

Response

Successful Response

blockedboolean required
budget_idstring nullable required
budget_started_atstring nullable required
created_atstring required
current_requestsinteger required
current_tokensinteger required
external_idstring required
next_budget_reset_atstring nullable required
owner_user_idstring required
reservednumber required
spendnumber required
user_idstring required

Changes