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

Find an Account by ID

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:Sid
GET
/api/laml/2010-04-01/Accounts/:Sid
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/Sid \
>     -u "<project_id>:<api_token>"
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472af",
3  "friendly_name": "My Project",
4  "status": "active",
5  "auth_token": "redacted",
6  "date_created": "Sat, 15 Sep 2018 10:00:00 +0000",
7  "date_updated": "Sat, 16 Sep 2018 10:00:00 +0000",
8  "type": "Full",
9  "owner_account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
10  "region_preference": "us-east",
11  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af",
12  "subproject": false,
13  "signing_key": null,
14  "subresource_uris": {
15    "addresses": null,
16    "available_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers",
17    "applications": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications",
18    "authorized_connect_apps": null,
19    "calls": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls",
20    "conferences": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences",
21    "connect_apps": null,
22    "incoming_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers",
23    "keys": null,
24    "notifications": null,
25    "outgoing_caller_ids": null,
26    "queues": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues",
27    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings",
28    "sandbox": null,
29    "sip": null,
30    "short_codes": null,
31    "messages": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages",
32    "transcriptions": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions",
33    "usage": null
34  }
35}

Find a Project (also referred to as Account) by ID.

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.

Was this page helpful?
Previous

Update an Account

Next
Built with

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) ```

Path parameters

SidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Project to retrieve.

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for this Project.
friendly_namestring
The name of the Project.
statusenum
The status of the Project. Always 'active'.
Allowed values:
auth_tokenstring
The authorization token for this Project. Always returns 'redacted' for security.
date_createdstring
The date and time this Project was created, in RFC 2822 format.
date_updatedstring
The date and time this Project was last updated, in RFC 2822 format.
typeenum
The type of the Project. Always 'Full'.
Allowed values:
owner_account_sidstringformat: "uuid"
The Project ID of the parent project. For parent projects, this is the same as sid.
region_preferencestring
The preferred region for the Project.
uristring
The URI for the Project.
subprojectboolean

Whether this project is a sub-project of another project.

signing_keystring or null
The signing key for the Project. Only returned once when a subproject is created. Subsequent requests return null.
subresource_urisobject

A map of URIs for sub-resources linked to this Project.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found 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)