Skip to main content

List Accounts

This endpoint will return a list that contains Project you are connecting as and any subprojects.

Permissions

The API token must include the following scopes: Management.

Query Parameters
FriendlyName string

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

Responses
200

OK

Schema OPTIONAL
links object OPTIONAL
uri string OPTIONAL
first_page_uri string OPTIONAL
next_page_uri string OPTIONAL
previous_page_uri string OPTIONAL
page integer OPTIONAL
page_size integer OPTIONAL
applications object[] OPTIONAL
auth_token string OPTIONAL

The authorization token for this Account. This token should be kept a secret and is not returned in a normal request.

date_created string OPTIONAL

The date, in RFC 2822 GMT format, this Account was created.

date_updated string OPTIONAL

The date, in RFC 2822 GMT format, this Account was updated.

friendly_name string OPTIONAL

The name of the account, up to 250 characters long.

owner_account_sid uuid OPTIONAL

The Project ID that uniquely identifies the parent of the Account.

sid uuid OPTIONAL

The Project ID that uniquely identifies the Account to retrieve.

status string OPTIONAL

The status of the Account. Possible values are: active, suspended, or closed.

subproject boolean OPTIONAL

Whether or not the project is a sub-project

subresource_uris object OPTIONAL

A Map of sub-accounts that are linked to the given Account.

available_phone_numbers uri OPTIONAL
calls uri OPTIONAL
conferences uri OPTIONAL
incoming_phone_numbers uri OPTIONAL
notifications uri OPTIONAL
outgoing_caller_ids uri OPTIONAL
recordings uri OPTIONAL
transcriptions uri OPTIONAL
addresses uri OPTIONAL
signing_keys uri OPTIONAL
connect_apps uri OPTIONAL
sip uri OPTIONAL
authorized_connect_apps uri OPTIONAL
usage uri OPTIONAL
keys uri OPTIONAL
applications uri OPTIONAL
short_codes uri OPTIONAL
queues uri OPTIONAL
messages uri OPTIONAL
type string OPTIONAL

The type of the Account. Possible values are: Trial and Full.

uri uri OPTIONAL

The URI for the Account.