Skip to navigation
Application TokensList application tokens

List application tokens

Required permissions Beta Learn more

ApplicationToken + List +1 endpoint

Roles: Administrator User Observer

Returns the application tokens of the requesting organisation.

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

To move from the v1 endpoints, see Migrate to the v2 application token API.

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.

sortstringOptional

Sort the tokens by one or more comma-separated fields: id, name, role, created_date, created_by, last_used_date, last_used_ip, expiry_date. Prefix a field with - for descending order, otherwise it’s ascending. Sorting by -last_used_date or -last_used_ip lists tokens that were never used last. created_by sorts by the creating user’s name; last_used_ip sorts as text, so 10.0.0.10 comes before 10.0.0.2. Tokens that are otherwise equal are ordered by id. Defaults to -created_date (newest first).

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