Skip to content
--- aside: false outline: false ---

Get many customers

GET
/clients/{clientId}/customers

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

clientId*
Type
string
Required
Pattern
"^cl_"

Query Parameters

pageIndex
Type
[ "integer", "null" ]
Minimum
0
Default
0
pageSize
Type
[ "integer", "null" ]
Minimum
0
Maximum
100
Default
25

Responses

Paged customer objects

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string",
  
  
  
"client": "string",
  
  
  
"firstName": "string",
  
  
  
"lastName": "string",
  
  
  
"email": "string",
  
  
  
"extId": "string",
  
  
  
"phone": "string"
  
  
}
  
],
  
"pageIndex": 0,
  
"pageSize": 0,
  
"totalCount": 0
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI