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.

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

Query parameters

  • CustomerName string

    The customer_name of the Address resources to read.

  • FriendlyName string

    The string that identifies the Address resources to read.

  • EmergencyEnabled boolean

    Whether the address can be associated to a number for emergency calling.

  • IsoCountry string(iso-country-code)

    The ISO country code of the Address resources to read.

  • PageSize integer(int64)

    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.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

        The SID of the Account that is responsible for the Address 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.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.

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

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

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

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

      • 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 that we created to identify the Address 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 | null

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

      • emergency_enabled boolean | null

        Whether emergency calling has been enabled on this number.

      • validated boolean | null

        Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been validated. false indicate the country doesn't require validation or the Address is not valid.

      • verified boolean | null

        Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been verified. false indicate the country doesn't require verified or the Address is not valid.

      • street_secondary string | null

        The additional number and street address of the address.

    • end integer
    • first_page_uri string(uri)
    • next_page_uri string(uri) | null
    • page integer
    • page_size integer
    • previous_page_uri string(uri) | null
    • start integer
    • uri string(uri)
GET /2010-04-01/Accounts/{AccountSid}/Addresses.json
curl \
 --request GET 'https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses.json' \
 --user "username:password"
Response examples (200)
{
  "end": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?FriendlyName=friendly_name&IsoCountry=US&CustomerName=customer_name&PageSize=50&Page=0",
  "page": 0,
  "start": 0,
  "addresses": [
    {
      "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
      "city": "SF",
      "region": "CA",
      "street": "4th",
      "verified": false,
      "validated": false,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "iso_country": "US",
      "postal_code": "94019",
      "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
      "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
      "customer_name": "name",
      "friendly_name": "Main Office",
      "street_secondary": null,
      "emergency_enabled": false
    }
  ],
  "page_size": 50,
  "next_page_uri": null,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?FriendlyName=friendly_name&IsoCountry=US&CustomerName=customer_name&PageSize=50&Page=0",
  "previous_page_uri": null
}
{
  "end": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?FriendlyName=friendly_name&IsoCountry=US&CustomerName=customer_name&PageSize=50&Page=0",
  "page": 0,
  "start": 0,
  "addresses": [],
  "page_size": 50,
  "next_page_uri": null,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses.json?FriendlyName=friendly_name&IsoCountry=US&CustomerName=customer_name&PageSize=50&Page=0",
  "previous_page_uri": null
}