Retrieve a list of address configurations for an account

GET /v1/Configuration/Addresses

Address Configuration resource manages the configurations related to a unique address within Conversations

Retrieve a list of address configurations for an account

Query parameters

  • Type string

    Filter the address configurations by its type. This value can be one of: whatsapp, sms.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • address_configurations array[object]
      Hide address_configurations attributes Show address_configurations attributes
      • account_sid string | null

        The unique ID of the Account the address belongs to.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • address string | null

        The unique address to be configured.

      • auto_creation

        Auto Creation configuration for the address.

      • date_created string(date-time) | null

        The date that this resource was created.

      • date_updated string(date-time) | null

        The date that this resource was last updated.

      • friendly_name string | null

        The human-readable name of this configuration.

      • sid string | null

        A 34 character string that uniquely identifies this resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IG[0-9a-fA-F]{32}$.

      • type string | null

        Type of Address.

      • url string(uri) | null

        An absolute URL for this address configuration.

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Configuration/Addresses 
curl \
 -X GET https://conversations.twilio.com/v1/Configuration/Addresses \
 --user "username:password"
Response examples (200) 
{
  "address_configurations": [
    {
      "account_sid": "string",
      "address": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "sid": "string",
      "type": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}