Avoca — Internal

Appearance

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

Search for availability across clients​

GET
/booking-flow/availability-search

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

client

Can be a comma-separated list

Type
string
Pattern
"^cl_"
startAt

Date component of an ISO date string. Must be current date or later.

Type
string
Pattern
"^\\d{4}-\\d{2}-\\d{2}$"
Default
"2000-01-01"
endAt

Date component of an ISO date string. Must be no more than 31 days after startAt

Type
string
Pattern
"^\\d{4}-\\d{2}-\\d{2}$"
Default
"2000-01-31"
servicePrefix
Type
string
Pattern
"^srvc_"
Default
"srvc_generic_availability_"
pageIndex
Type
[ "integer", "null" ]
Minimum
0
Default
0
pageSize
Type
[ "integer", "null" ]
Minimum
0
Maximum
10
Default
10

Responses​

Paged search results

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"client": "string",
  
  
  
"servicePrefixMatch": true,
  
  
  
"timeZone": "string",
  
  
  
"firstAvailabilityAt": "string",
  
  
  
"firstAvailabilityTimeslots": [
  
  
  
  
{
  
  
  
  
  
"time": "string",
  
  
  
  
  
"label": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"pageIndex": 0,
  
"pageSize": 0,
  
"totalCount": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI