Accounts

View as Markdown

Accounts allow you to list and update your SignalWire Projects. You can create any number of projects on the SignalWire Dashboard and use the Accounts endpoint to list or update them.

Properties

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.

Example object

The Account Object
1{
2 "sid": "string",
3 "friendly_name": "string",
4 "status": "active",
5 "auth_token": "string",
6 "date_created": "string",
7 "date_updated": "string",
8 "type": "Full",
9 "owner_account_sid": "string",
10 "region_preference": "string",
11 "uri": "string",
12 "subproject": true,
13 "signing_key": "string",
14 "subresource_uris": {
15 "addresses": {},
16 "available_phone_numbers": "string",
17 "applications": "string",
18 "authorized_connect_apps": {},
19 "calls": "string",
20 "conferences": "string",
21 "connect_apps": {},
22 "incoming_phone_numbers": "string",
23 "keys": {},
24 "notifications": {},
25 "outgoing_caller_ids": {},
26 "queues": "string",
27 "recordings": "string",
28 "sandbox": {},
29 "sip": {},
30 "short_codes": {},
31 "messages": "string",
32 "transcriptions": "string",
33 "usage": {}
34 }
35}