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
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
          • create
          • get
          • list
          • update
        • Applications
        • Calls
        • Conferences
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatAccounts

get

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

list

Next
Built with

Retrieve a single account by its SID.

Path parameters

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

Response

sidstringRequiredformat: "uuid"
The unique identifier for this Project.
friendly_namestringRequired
The name of the Project.
statusenumRequired
The status of the Project. Always 'active'.
Allowed values:
auth_tokenstringRequired
The authorization token for this Project. Always returns 'redacted' for security.
date_createdstringRequired
The date and time this Project was created, in RFC 2822 format.
date_updatedstringRequired
The date and time this Project was last updated, in RFC 2822 format.
typeenumRequired
The type of the Project. Always 'Full'.
Allowed values:
owner_account_sidstringRequiredformat: "uuid"
The Project ID of the parent project. For parent projects, this is the same as sid.
region_preferencestringRequired
The preferred region for the Project.
uristringRequired
The URI for the Project.
subprojectbooleanRequired
Whether this project is a sub-project of another project.
signing_keystring or nullRequired
The signing key for the Project. Only returned once when a subproject is created. Subsequent requests return null.
subresource_urisobjectRequired
A map of URIs for sub-resources linked to this Project.

Response Example

Response
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}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com",
7});
8
9const account = await client.compat.accounts.get("account-sid");