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

Get many booking sessions

GET

/clients/{clientId}/booking-sessions

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

clientId*

Type

string

Required

Pattern

"^cl_"

Query Parameters

finalizedType

Type

string

Valid values

"Abandon""Lead""Appointment"

pageIndex

Type

[ "integer", "null" ]

Minimum

0

Default

0

pageSize

Type

[ "integer", "null" ]

Minimum

0

Maximum

100

Default

25

Responses

Paged booking session objects

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"client": "string",

  

  

  

"sourceTracking": {

  

  

  

  

"additionalProperties": "string"

  

  

  

},

  

  

  

"issues": [

  

  

  

  

{

  

  

  

  

  

"issueDescription": [

  

  

  

  

  

  

"string"

  

  

  

  

  

],

  

  

  

  

  

"customerNotes": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"services": [

  

  

  

  

{

  

  

  

  

  

"issueDescription": [

  

  

  

  

  

  

"string"

  

  

  

  

  

],

  

  

  

  

  

"customerNotes": "string",

  

  

  

  

  

"estimatedValue": 0,

  

  

  

  

  

"service": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"existingCustomer": "string",

  

  

  

"newCustomer": {

  

  

  

  

"email": "string",

  

  

  

  

"firstName": "string",

  

  

  

  

"lastName": "string",

  

  

  

  

"phone": "string"

  

  

  

},

  

  

  

"existingVehicle": "string",

  

  

  

"newVehicle": {

  

  

  

  

"make": "string",

  

  

  

  

"model": "string",

  

  

  

  

"year": 0,

  

  

  

  

"license": "string"

  

  

  

},

  

  

  

"appointmentType": "string",

  

  

  

"scheduleStartAt": "string",

  

  

  

"scheduleEndAt": "string",

  

  

  

"transportationRequest": "string",

  

  

  

"finalizedAt": "string",

  

  

  

"finalizedType": "string",

  

  

  

"marketingSource": "string",

  

  

  

"aoIssueTreeKey": "string",

  

  

  

"aoThemeKey": "string",

  

  

  

"aoIPAddress": "string",

  

  

  

"aoLanguage": "string"

  

  

}

  

],

  

"pageIndex": 0,

  

"pageSize": 0,

  

"totalCount": 0

}

GET

/clients/{clientId}/booking-sessions

Playground

Authorization

bearerAuth

Variables

Key

Value

clientId*

finalizedType

pageIndex

pageSize

Samples

Powered by VitePress OpenAPI