Admin

Get All Admins

get

Get all administrators

Authorizations

Query parameters

takeany ofOptionalDefault: 10

notOptional

or

numberOptional

skipany ofOptionalDefault: 0

notOptional

or

numberOptional

idFilterany ofOptional

Comma-separated ids to filter by

notOptional

or

string[]Optional

allowFuzzyIdFilterbooleanOptional

Set to true to enable fuzzy id filtering. If false, only returns exact matches.

Default: false

sortFieldstring · enumOptional

Field to sort by

Possible values:

sortOrderstring · enumOptional

Sort order for the selected field

Possible values:

Responses

get

HTTPcURLJavaScriptPython

GET /api/administrators HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "administrators": [
    {
      "id": "text",
      "displayName": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "lastSeen": "text"
    }
  ]
}

Get Admin Count

get

Get the total number of administrators. Useful for pagination.

Authorizations

Query parameters

idFilterany ofOptional

Comma-separated ids to filter by

notOptional

or

string[]Optional

allowFuzzyIdFilterbooleanOptional

Set to true to enable fuzzy id filtering. If false, only returns exact matches.

Default: false

Responses

get

HTTPcURLJavaScriptPython

GET /api/administrators/count HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}