Skip to navigation
Application TokensList application tokens

List application tokens

Returns the application tokens of the requesting organisation.

Only tokens in status ACTIVE are returned unless the q filter asks otherwise. The token itself is never returned; it is available only from the response of the create endpoint.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Query parameters

qstringOptional

Filter the tokens. The only key is status, whose values are the ids that GET /api/v2/application_token/status lists: q=status:1 for the active tokens, q=status:3 for the deleted ones, q=status:1||3 for both. Percent-encode the pipes - q=status:1%7C%7C3 - as an unencoded | is not a legal URI character and is rejected before the request arrives. Defaults to active tokens only.

Response

Success
idinteger
Unique ID of this application token.
namestring
statusobject
roleslist of objects
The role granted to the token.
created_datestringformat: "date-time"
ip_restrictionslist of objectsOptional
IP addresses the token may connect from. Absent where it may connect from any.
expiry_datestringOptionalformat: "date-time"
Absent for a token created without one through the v1 API.
last_used_datestringOptionalformat: "date-time"
Absent until the token has been used.
last_used_ipstringOptional
IP address the token was last used from.
created_byobjectOptional
A user that acted on the token. Absent where an application token acted instead.
last_modified_datestringOptionalformat: "date-time"
Absent until the token has been modified.
last_modified_byobjectOptional
A user that acted on the token. Absent where an application token acted instead.
deleted_datestringOptionalformat: "date-time"
Set only once the token has been deleted.
deleted_byobjectOptional
A user that acted on the token. Absent where an application token acted instead.

Errors

400
Bad Request Error
403
Forbidden Error