Skip to navigation
Compatibility REST APIAccounts

List Accounts

View as MarkdownOpen in Claude

Lists the project used to authenticate the request and its subprojects as Account resources. Use it when an integration identifies SignalWire projects by Account SID. For JSON project-management operations, use List projects.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.

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)

Query parameters

FriendlyNamestringOptional

A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

PageintegerOptional>=0Defaults to 0

The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.

PageSizeintegerOptional1-1000Defaults to 50
The number of results to return per page. The default is 50, and the maximum is 1000.
PageTokenstringOptional
A token used to retrieve a specific page of results. The token is returned in the response of a previous request.

Response

The request has succeeded.
uristring
The URI of the current page.
first_page_uristring
The URI of the first page.
next_page_uristring or null
The URI of the next page. Null if there are no more results.
previous_page_uristring or null
The URI of the previous page. Null if this is the first page.
pageinteger

The current page number (zero-indexed).

page_sizeinteger
The number of results per page.
accountslist of objects
List of accounts.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error