List or search site customers

GET

/product/sites/{siteId}/customers

Authorizations

BearerAuth

JWT token from login

Type

HTTP (bearer)

or

AccessToken

Personal access token. Value: Token <your-token>

Type

API Key (header: Authorization)

Parameters

Path Parameters

siteId*

Type

string

Required

Query Parameters

q

Optional customer search across name, email, and external ID.

Type

string

limit

Maximum customers returned when searching.

Type

integer

Default

25

Maximum

100

Responses

OK

GET

/product/sites/{siteId}/customers

Playground

Authorization

BearerAuth

Variables

Key

Value

siteId*

q

limit

Samples

Powered by VitePress OpenAPI