Skip to main content

List Accounts

GET 

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

Request

Query Parameters

    FriendlyName string

Responses

OK

Schema

    links

    object

    uristring
    first_page_uristring
    next_page_uristring
    previous_page_uristring
    pageinteger
    page_sizeinteger

    applications

    object[]

  • Array [

  • auth_tokenstring

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

    Example: Redacted
    date_createdstring

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

    Example: Sat, 15 Sept 2018 10:00:00 +0000
    date_updatedstring

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

    Example: Sat, 16 Sept 2018 10:00:00 +0000
    friendly_namestring

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

    Example: My Project
    owner_account_siduuid

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

    siduuid

    The Project ID that uniquely identifies the Project to retrieve.

    statusstring

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

    subprojectboolean

    Whether or not the project is a sub-project

    subresource_uris

    object

    A Map of sub-projects that are linked to the given Project.

    available_phone_numbersuri
    callsuri
    conferencesuri
    incoming_phone_numbersuri
    notificationsuri
    outgoing_caller_idsuri
    recordingsuri
    transcriptionsuri
    addressesuri
    signing_keysuri
    connect_appsuri
    sipuri
    authorized_connect_appsuri
    usageuri
    keysuri
    applicationsuri
    short_codesuri
    queuesuri
    messagesuri
    typestring

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

    Example: Full
    uriuri

    The URI for the Project.

  • ]