Accounts

List Accounts

Changed on

Lists the project used to authenticate the request and its subprojects as Account resources. Use it when an integration identifies SignalWire projects by Account SID. For JSON project-management operations, use List projects.

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

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
  • Auth
    HTTP basic

Query parameters

FriendlyNamestring

A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

Pageinteger

The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.

PageSizeinteger

The number of results to return per page. The default is 50, and the maximum is 1000.

PageTokenstring

A token used to retrieve a specific page of results. The token is returned in the response of a previous request.

Response

The request has succeeded.

uristring required

The URI of the current page.

first_page_uristring required

The URI of the first page.

next_page_uristring nullable required

The URI of the next page. Null if there are no more results.

previous_page_uristring nullable required

The URI of the previous page. Null if this is the first page.

pageinteger required

The current page number (zero-indexed).

page_sizeinteger required

The number of results per page.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
  "first_page_uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
  "next_page_uri": "/api/laml/2010-04-01/Accounts?Page=1&PageSize=50",
  "page_size": 50,
  "accounts": [
    {
      "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

    • info

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