GET
/
customers
/
{customerId}
/
customer-address

Authorizations

Authorization
string
headerrequired

The access token.

Headers

x-fabric-tenant-id
string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id
string

A UUID of the request.

Path Parameters

customerId
string
required

A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.

Query Parameters

offset
integer
default: 0

The number of records to skip before returning records. For example, when offset is 20 and limit's 10, this endpoint returns records from 21 to 30.

limit
integer
default: 10

The maximum number of records per page.

sort
string

The criteria to sort results, where - indicates a descending order and + indicates an ascending order. You can sort the following fields - updatedAt, country, city, and region.

isDeleted
boolean

A flag indicating whether only the deleted addresses must be included in the response. Set to true to include only the deleted addresses of the customers and false to exclude the deleted addresses.

Response

200 - application/json

The list of customer addresses for the customerId.

query
object

The pagination criteria.

data
object[]

addresses of the sent customer