Skip to navigation

List API tokens

View as MarkdownOpen in Claude

Lists the project API tokens the caller can manage, newest first. Use it to find the id of a token before you update, regenerate, or delete it, or to check when each token last authenticated a request.

Token values are never returned. A token’s value appears only in the response that issued it: Create API token or Regenerate API token.

With a project API token, the list covers the tokens of the authenticated project and its subprojects. With a Personal access token, it covers the tokens of every project the token holder is enabled for, plus their subprojects. Pass project_id to narrow the list to one project.

Permissions

With a project API token, the token must have the following scope(s) enabled to make a successful request: Management.

With a Personal access token there are no scopes. The token holder must be an owner or admin of the space, and the request reaches only the projects the holder is enabled for, plus their subprojects.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)
OR
AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project’s: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Query parameters

project_idstringOptionalformat: "uuid"
Only return tokens that belong to this project. A project the caller cannot reach, or a value that is not a valid project ID, returns an empty list rather than an error.
page_sizeintegerOptional1-1000Defaults to 50
The number of results per page.
page_tokenstringOptional

Cursor token for paging, taken from the next or prev link of a previous response.

page_numberintegerOptional>=0Defaults to 0

The page index. A value above 0 requires page_token.

Response

The request has succeeded.
datalist of objects
The tokens on this page. Token values are never included.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error