Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

Free-text search across the customer's name, email and customerId.

page_size
integer

Number of results to return per page. Defaults to 10, maximum 100.

Required range: 1 <= x <= 100
page
integer

The page number of results to return.

Response

200 - application/json

A paginated list of customers.

count
integer
next
string<uri> | null
previous
string<uri> | null
results
object[]