List address

GET /2010-04-01/Accounts/{AccountSid}/Addresses.json

An Address instance resource represents your or your customer's physical location within a country. Around the world, some local authorities require the name and address of the user to be on file with Twilio to purchase and own a phone number.

Path parameters

  • AccountSid string Required

    The SID of the Account that is responsible for the Address resource to read.

Query parameters

  • CustomerName string

    The customer_name of the Address resources to read.

  • FriendlyName string

    The string that identifies the Address resources to read.

  • IsoCountry string(iso-country-code)

    The ISO country code of the Address resources to read.

  • 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
    • addresses array[object]
      Hide addresses attributes Show addresses attributes
      • account_sid string | null

        The SID of the Account that is responsible for the resource

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

      • city string | null

        The city in which the address is located

      • customer_name string | null

        The name associated with the address

      • date_created string(date-time-rfc-2822) | null

        The RFC 2822 date and time in GMT that the resource was created

      • date_updated string(date-time-rfc-2822) | null

        The RFC 2822 date and time in GMT that the resource was last updated

      • emergency_enabled boolean | null

        Whether emergency calling has been enabled on this number

      • friendly_name string | null

        The string that you assigned to describe the resource

      • iso_country string(iso-country-code) | null

        The ISO country code of the address

      • postal_code string | null

        The postal code of the address

      • region string | null

        The state or region of the address

      • sid string | null

        The unique string that identifies the resource

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

      • street string | null

        The number and street address of the address

      • uri string(uri) | null

        The URI of the resource, relative to https://api.twilio.com

      • validated boolean | null

        Whether the address has been validated to comply with local regulation

      • verified boolean | null

        Whether the address has been verified to comply with regulation

    • end integer
    • first_page_uri string(uri)
    • next_page_uri string(uri)
    • page integer
    • page_size integer
    • previous_page_uri string(uri)
    • start integer
    • uri string(uri)
GET /2010-04-01/Accounts/{AccountSid}/Addresses.json 
curl \
 -X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses.json \
 --user "username:password"
Response examples (200) 
{
  "addresses": [
    {
      "account_sid": "string",
      "city": "string",
      "customer_name": "string",
      "date_created": "string",
      "date_updated": "string",
      "emergency_enabled": true,
      "friendly_name": "string",
      "iso_country": "string",
      "postal_code": "string",
      "region": "string",
      "sid": "string",
      "street": "string",
      "uri": "https://example.com",
      "validated": true,
      "verified": true
    }
  ],
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com"
}