Skip to navigation

List projects

View as MarkdownOpen in Claude

Lists the projects the caller can reach.

With a project API token, that is the authenticated root project and its subprojects. With a Personal access token, it is every root project the token holder is enabled for, plus their subprojects.

Filter by name when locating a project, or use Retrieve a project when you already have its ID. Integrations built around Compatibility API Account SIDs can use List accounts instead.

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

namestringOptional
Filter projects by name.
page_sizeintegerOptional1-1000Defaults to 50
The number of results per page.
page_tokenstringOptional

Cursor token for paging, taken from the links in a previous response.

page_numberintegerOptional>=0Defaults to 0

The page index, used together with page_token.

Response

The request has succeeded.
datalist of objects
The projects on this page.

Errors

401
Unauthorized Error
500
Internal Server Error