Find an Account by ID

{
  "sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "friendly_name": "My Project",
  "status": "active",
  "auth_token": "redacted",
  "date_created": "Sat, 15 Sep 2018 10:00:00 +0000",
  "date_updated": "Sat, 16 Sep 2018 10:00:00 +0000",
  "type": "Full",
  "owner_account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "region_preference": "us-east",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af",
  "subproject": false,
  "signing_key": null,
  "subresource_uris": {
    "addresses": null,
    "available_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers",
    "applications": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications",
    "authorized_connect_apps": null,
    "calls": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls",
    "conferences": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences",
    "connect_apps": null,
    "incoming_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers",
    "keys": null,
    "notifications": null,
    "outgoing_caller_ids": null,
    "queues": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings",
    "sandbox": null,
    "sip": null,
    "short_codes": null,
    "messages": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages",
    "transcriptions": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions",
    "usage": null
  }
}

Retrieves one project as an Account by SID. Use it when an integration identifies projects with Account SIDs; use Retrieve a project for the SignalWire REST representation.

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.

Retrieves one project as an Account by SID. Use it when an integration identifies projects with Account SIDs; use [Retrieve a project](/docs/apis/rest/projects/get-project) for the SignalWire REST representation. #### 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).

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)

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'.

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'.

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