Availability Block

AvailabilityBlock

object
created_at
string <date-time>
ends_at
string <date-time>
id
string <int64>
object
object
object or null
starts_at
string <date-time>
updated_at
string <date-time>
{}

List availability blocks

get/availability_blocks
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
business_id int64
created_at date-time
id int64
practitioner_id int64
starts_at date-time
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create availability block
post/availability_blocks
SecuritybasicAuth 
Request 
Request Body schema: application/json
business_id
string <int64> 
business id


 
ends_at
string <date-time> 
 
practitioner_id
string <int64> 
practitioner id


 
object or null
 
starts_at
string <date-time> 
 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "business_id": "1",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "practitioner_id": "1",
  • "starts_at": "2019-08-24T14:15:22Z",
  • "repeat_rule": {
    • "number_of_repeats": 0,
    • "repeat_type": "Daily",
    • "repeating_interval": 0
    }
}
Response samples 
application/json
{}
Get availability block
get/availability_blocks/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}