Skip to main content

List all addresses

GET 
/addresses

Returns a list of your addresses.

Request​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[customer_reference][eq] string

    Filter addresses via the customer reference set. Matching is not case-sensitive.

    filter[customer_reference][contains] string

    If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive.

    filter[used_as_emergency] string

    Default value: null

    If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false', the opposite happens: only addresses not used as the emergency address from phone-numbers will be returned.

    filter[street_address][contains] string

    Default value: null

    If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

    filter[address_book][eq] string

    Default value: null

    If present, only returns results with the address_book flag set to the given value.

    sort string

    Possible values: [created_at, first_name, last_name, business_name, street_address]

    Default value: created_at

    Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

    That is:

    • street_address: sorts the result by the street_address field in ascending order.
    • -street_address: sorts the result by the street_address field in descending order.

    If not given, results are sorted by 
    created_at
    in descending order.

Responses​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id int64

    Uniquely identifies the address.

    record_type string

    Identifies the type of the resource.

    customer_reference customer_reference (string)

    A customer reference string for customer look ups.

    first_name first_name (string)

    The first name associated with the address. An address must have either a first last name or a business name.

    last_name last_name (string)

    The last name associated with the address. An address must have either a first last name or a business name.

    business_name business_name (string)

    The business name associated with the address. An address must have either a first last name or a business name.

    phone_number phone_number (string)

    The phone number associated with the address.

    street_address street_address (string)

    The primary street address information about the address.

    extended_address extended_address (string)

    Additional street address information about the address such as, but not limited to, unit number or apartment number.

    locality locality (string)

    The locality of the address. For US addresses, this corresponds to the city of the address.

    administrative_area administrative_area (string)

    The locality of the address. For US addresses, this corresponds to the state of the address.

    neighborhood neighborhood (string)

    The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.

    borough borough (string)

    The borough of the address. This field is not used for addresses in the US but is used for some international addresses.

    postal_code postal_code (string)

    The postal code of the address.

    country_code country_code (string)

    The two-character (ISO 3166-1 alpha-2) country code of the address.

    address_book address_book (boolean)

    Default value: true

    Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.

    validate_address validate_address (boolean)

    Default value: true

    Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of true unless you have used the /addresses/actions/validate endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request

401: Unauthorized

404: Resource not found

Loading...