/v1/availability

get

https://api.apptoto.com/v1/availability

This endpoint allows you to fetch times that are available to book appointments on your apptoto booking pages.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

By default, the result will be an array of times in ISO8601 format. Only available times will be returned.

If you need all of the possible times returned with an "available" flag on each, then set the "expanded" flag to true.

{
	"availability": [
    {
      "time": "2023-03-24T11:30:00",
      "available": true,
      "link": "https://booktimewithme.apptoto.com/default/12313213"
    },
    {
      "time": "2023-03-24T12:00:00",
      "available": false
    },
    ...
  ]
}

OAuth scope

Calls authenticated with an OAuth 2.0 bearer token must include the bookings:read scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.

Query Params

begin

date

(Required) The beginning of the date range to fetch availability for.

end

date

(Required) The ending of the date range to fetch availability for.

booking_page

string

(Required) The booking page id or subdomain. E.g if your booking page is hosted at https://bookwithme.apptoto.com/ then you would pass "bookwithme" for the booking_page parameter.

appointment_type

string

If your booking page has multiple appointment types, then you must pass in the appointment_type token that you want availability for.

expanded

boolean

Defaults to false

If expanded is false, then an array of available times will be returned. If expanded is true, then an array of objects will be returned. Each object will have the time, whether or not it's available, and a link to use to book the time.

include_links

boolean

Defaults to false

If include_links is set to true, then the return value will include a link for each available time that clients can use to book that time. Note that if expanded is set to true, then the default for this parameter is true.