Skip to main content
GET
List customers
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Query Parameters

page_number
integer

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

page_size
integer
default:30

Number of results per page. Defaults to 30 when omitted, and cannot exceed 100.

Required range: x <= 100
email
string

Return only the customer with this email address. The match is exact and case-insensitive.

Example:

"john@example.com"

Response

OK - Request succeeded

customers
object[]
pagination
object