List Customers

GET /customers

You can use this endpoint to retrieve a list of customers. You can use the filter parameter to filter the list of customers.

In addition to using filters, you can also use direct query parameters for specific fields:

Parameter	Type	Description
`member-number`	`number`	Directly query a customer by their member number
`email`	`string`	Directly query a customer by their email address

These direct parameters are more efficient than using filters when querying for exact matches on these fields and provide strong consistency guarantees.

Use the Pagination and Querying sections to learn more about how to complete this request.

Available Fields to Query

Field Name	Type
`NAME`	`string`
`FIRST_NAME`	`string`
`LAST_NAME`	`string`
`EMAIL`	`string`
`PHONE`	`string`
`MEMBER_NUMBER`	`number`
`INITIALS`	`string`
`CREATED_AT`	`date`
`UPDATED_AT`	`date`
`SUBSCRIBED_TO_NEWSLETTER`	`boolean`
`MEMBERSHIP`	`Membership`
`CHECKIN`	`Checkin`
`TRANSACTION`	`Transaction`