List Addresses
Retrieve a list of addresses in a customer. The addresses can be filtered by fields like query
. The addresses can also be paginated.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The customer's ID.
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with +
it will be added to the default fields, using -
will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the Retrieve Custom Links documentation.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -
.
Search term to apply on the address's searchable properties.
Filter by a company.
Filter by a city.
Filter by a currency code.
Filter by an ISO 3166-2 province code. Must be lower-case.
"us-ca"
Filter by a postal code.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Whether to include deleted records in the result.
Response
OK
The paginated list of customer addresses.