For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • GETList Accounts
      • POSTCreate Subprojects
      • GETFind an Account by ID
      • POSTUpdate an Account
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIAccounts

List Accounts

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts
GET
/api/laml/2010-04-01/Accounts
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts \
>     -u "<project_id>:<api_token>"
1{
2  "uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
3  "first_page_uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
4  "next_page_uri": "/api/laml/2010-04-01/Accounts?Page=1&PageSize=50",
5  "previous_page_uri": null,
6  "page": 0,
7  "page_size": 50,
8  "accounts": [
9    {
10      "sid": "b3877c40-da60-4998-90ad-b792e98472af",
11      "friendly_name": "My Project",
12      "status": "active",
13      "auth_token": "redacted",
14      "date_created": "Sat, 15 Sep 2018 10:00:00 +0000",
15      "date_updated": "Sat, 16 Sep 2018 10:00:00 +0000",
16      "type": "Full",
17      "owner_account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
18      "region_preference": "us-east",
19      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af",
20      "subproject": false,
21      "signing_key": null,
22      "subresource_uris": {
23        "addresses": null,
24        "available_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers",
25        "applications": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications",
26        "authorized_connect_apps": null,
27        "calls": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls",
28        "conferences": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences",
29        "connect_apps": null,
30        "incoming_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers",
31        "keys": null,
32        "notifications": null,
33        "outgoing_caller_ids": null,
34        "queues": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues",
35        "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings",
36        "sandbox": null,
37        "sip": null,
38        "short_codes": null,
39        "messages": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages",
40        "transcriptions": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions",
41        "usage": null
42      }
43    }
44  ]
45}
This endpoint will return a list that contains Project you are connecting as and any subprojects. #### 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](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

Create Subprojects

Next
Built with

This endpoint will return a list that contains Project you are connecting as and any subprojects.

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

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)