--- aside: false outline: false ---

Get many clients

GET

/clients

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

pageIndex

Type

[ "integer", "null" ]

Minimum

0

Default

0

pageSize

Type

[ "integer", "null" ]

Minimum

0

Maximum

100

Default

25

Responses

Paged client objects

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"steerTenantId": "string",

  

  

  

"steerShopId": "string",

  

  

  

"key": "string",

  

  

  

"name": "string",

  

  

  

"internalId": "string",

  

  

  

"organization": "string",

  

  

  

"clientGroup": "string",

  

  

  

"homePageUrl": "string",

  

  

  

"phone": "string",

  

  

  

"sms": "string",

  

  

  

"smsStatus": "string",

  

  

  

"smsStatusUpdatedAt": "string",

  

  

  

"smsId": "string",

  

  

  

"status": "string",

  

  

  

"addressLine1": "string",

  

  

  

"addressLine2": "string",

  

  

  

"addressLocality": "string",

  

  

  

"addressRegion": "string",

  

  

  

"addressPostalCode": "string",

  

  

  

"addressCountryCode": "string",

  

  

  

"addressTimeZone": "string",

  

  

  

"addressLatitude": "string",

  

  

  

"addressLongitude": "string"

  

  

}

  

],

  

"pageIndex": 0,

  

"pageSize": 0,

  

"totalCount": 0

}

GET

/clients

Playground

Authorization

bearerAuth

Variables

Key

Value

pageIndex

pageSize

Samples

Powered by VitePress OpenAPI