Skip to navigation
RESTAdminManagementCustomersV3Addresses

List Customer Addresses

Returns a list of Customer Addresses. Optional filter parameters can be passed in.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Customersmodifystore_v2_customers
Customersread-onlystore_v2_customers_read_only
Stored Payment Instrumentsmodifystore_stored_payment_instruments
Stored Payment Instrumentsread-onlystore_stored_payment_instruments_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringOptionalDefaults to application/json

The MIME type of the response body that the client accepts. Typically application/json.

Query parameters

pageintegerOptional

Page number. page=1

limitdoubleOptional

Items count per page. limit=50

company:inlist of stringsOptional

Filter items by company. company:in=bigcommerce,commongood

name:inlist of stringsOptional

Filter items by first_name and last_name. name:in=James+Moriarty

customer_id:inlist of integersOptional

Filter by the ID of the customer. Also accepts comma-separated IDs to filter for multiple customers. customer_id:in=23,24,55

includelist of enumsOptional

Indicates whether to include customer address sub-resources:

  • formfields - address form fields include=formfields
Allowed values:
id:inlist of integersOptional

Filter items by ID. id:in=4,5,6

Response

A list of customer addresses.
datalist of objectsOptional
metaobjectOptional
Data about the response, including pagination and collection totals.