Skip to main content
GET
List location customers

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

location_id
string
required

Query Parameters

limit
integer
default:10

Page size (1–100).

Required range: 1 <= x <= 100
starting_after
string

Return customers after this customer id.

ending_before
string

Return customers before this customer id.

created_after
string<date-time>

Return customer profiles created after this ISO 8601 timestamp.

created_before
string<date-time>

Return customer profiles created before this ISO 8601 timestamp.

updated_after
string<date-time>

Return customer profiles updated after this ISO 8601 timestamp.

updated_before
string<date-time>

Return customer profiles updated before this ISO 8601 timestamp.

Return customers with this marketing consent status. Missing consent records match unknown.

Available options:
opted_in,
opted_out,
unknown
min_completed_orders
integer

Return customers with at least this many completed orders in the route scope.

Required range: x >= 0

Response

A paginated list of location customers.

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required