Avoca — Internal

Appearance

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

Get availability for a date range​

GET
/booking-flow/{clientId}/availability

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

clientId*
Type
string
Required
Pattern
"^cl_"

Query Parameters

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 90 days after startAt

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

Can be a comma-separated list

Type
string
Required
Pattern
"^srvc_"
isDroppingOff*
Type
string
Required
Valid values
"true""false"
Default
"true"
isNewCustomer*
Type
string
Required
Valid values
"true""false"
Default
"false"

Responses​

Availability results

application/json
JSON
{
  
"dates": [
  
  
{
  
  
  
"date": "string",
  
  
  
"timeslots": [
  
  
  
  
{
  
  
  
  
  
"time": "string",
  
  
  
  
  
"label": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI