REST API – Get Addresses

Modified on Thu, 2 Jul, 2020 at 7:38 PM

About

Retrieve current details of addresses associated with an account. Addresses can be added or removed using our Add and Remove Addresses requests.

Resource URIs

Retrieve a single address record or a list of addresses belonging to an account.

GET

/v2/Accounts/[AccountSid]/Addresses

or

/v2/Addresses/[AddressSid]

Request

URI Parameters

Parameter	Type	Description
AccountSid	string	Secure identification of an account.
AddressSid	string	Secure identification of a single address to retrieve the details of.

Optional Include Parameters

These parameters are only associated with the request for a list of address records. Results can be filtered with any number of the following parameters.

Parameter	Type	Description
Friendly (Optional)	string	Return addresses with exact matches of this assigned friendly name.
Reference (Optional)	string	Return addresses with exact matches of this reference.
City (Optional)	string	Return addresses associated with exact matches of this city.
Region (Optional)	string	Return addresses associated with exact matches of this region.
CountryCode (Optional)	string	Return addresses associated with this country code.
PostalCode (Optional)	string	Return addresses that have this postal code.
Results_Count	integer	Specify the number of results to return. Default number of results is 200.
Results_Skip	integer	Specify a number of records to skip before starting results. This enables custom pagination.

Response

200 – OK

Our service will respond to every address request with JSON formatted data. Requests for multiple addresses will respond with a list of addresses filtered by the optional parameters. Requests for single addresses will be returned as a single JSON object.

Response Parameters

Parameter	Type	Description
AddressSid	string	The address secure identifier created for the new address.
AccountSid	string	The account secure identifier associated with the address.
Friendly	string	The friendly name associated with the address (if assigned).
Reference	string	A definable reference string associated with the address.
Line1	string	Address line 1.
Line2	string	Address line 2.
City	string	City name (if applicable).
Region	string	Region of address.
CountryCode	string	Country code of the address. E.g AU or US
PostalCode	string	Postal code of the address. E.g. 2620.
Status	string	Status of the address. In most cases, addresses will be approved immediately. May be: Active : Address is active and numbers can be registered against it. Pending : The address is pending verification. Numbers cannot yet be registered. Rejected : Address information was deemed incorrect. Re-submission is required.

400 – Error

For error codes and messages, please refer here.