Accounts

Find an Account by ID

Changed on

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.

get/Accounts/{Sid}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{Sid}
  • Auth
    HTTP basic

Path parameters

Sidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Project to retrieve.

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

friendly_namestring required

The name of the Project.

status'active' required

The status of the Project.

auth_tokenstring required

The authorization token for this Project. Always returns 'redacted' for security.

date_createdstring required

The date and time this Project was created, in RFC 2822 format.

date_updatedstring required

The date and time this Project was last updated, in RFC 2822 format.

type'Full' required

The type of the Project.

owner_account_sidstring uuid required

Universal Unique Identifier.

region_preferencestring required

The preferred region for the Project.

uristring required

The URI for the Project.

subprojectboolean required

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

signing_keystring nullable required

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

Example response

{
  "friendly_name": "My Project",
  "auth_token": "redacted",
  "date_created": "Sat, 15 Sep 2018 10:00:00 +0000",
  "date_updated": "Sat, 16 Sep 2018 10:00:00 +0000",
  "region_preference": "us-east",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af",
  "subresource_uris": {
    "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",
    "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",
    "incoming_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers",
    "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",
    "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"
  }
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status