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

Get a client

GET

/clients/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Pattern

"^cl_"

Responses

Client object

Content-Type

application/json

{

  

"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"

}

GET

/clients/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI