Calendars

List calendar availability (paginated)

Returns the bookable appointment slots for a clinic’s calendar resources over a date range of up to 7 days.

Calendar availability represents the open appointment slots for each resource on a calendar, with all scheduling rules applied — resource schedules, existing appointments, calendar events, designations, and business hours are all accounted for. Availability can be requested for one or more resources and one or more appointment kinds at once; the result is computed independently for each resource-and-kind combination, since an appointment kind’s configured duration and designation-based restrictions affect which slots are bookable.

The appointment length used to size the returned slots defaults to the kind’s configured duration, but can be overridden with a custom length that applies to every requested kind. Start times are offered on the calendar’s block-increment grid rather than stepping by the appointment length, so overlapping start times are returned (for example, a 15-minute grid with a 30-minute appointment offers starts at 8:00, 8:15, and 8:30). Grid alignment is computed in the clinic’s local time.

Results are paginated by appointment slot rather than by resource. When a resource’s slots span a page boundary, that resource appears on consecutive pages with the remaining slots.

To keep responses bounded, the number of requested appointment kinds per call is capped, and each page returns a bounded number of slots.

GET

ext

calendar-availability

paginated

List calendar availability (paginated)

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/calendar-availability/paginated/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/calendar-availability/paginated/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/calendar-availability/paginated/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/calendar-availability/paginated/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/calendar-availability/paginated/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/calendar-availability/paginated/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "appointment_kind_id": 123,
      "calendar_resource_id": 123,
      "calendar_resource_name": "<string>",
      "slots": [
        {
          "end_datetime": "2023-11-07T05:31:56Z",
          "start_datetime": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date

string

required

Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before end_date. Format: YYYY-MM-DD

end_date

string | null

End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after start_date. Defaults to start_date if omitted. Format: YYYY-MM-DD

calendar_resource_ids

integer[] | null

Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.

appointment_kind_ids

integer[] | null

Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.

duration

integer | null

Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.

limit

integer

default:1000

The maximum number of appointment slots to return per page, counted by summing nested slots across every resource/kind entry on that page. A resource/kind group that spans a page boundary is split, and only the slots on this page count toward the limit. Defaults to 1000; the maximum is 5000.

Required range: 1 <= x <= 5000

cursor

string | null

A cursor token from a previous response's next page URL. Fetches slots after the last slot of the previous page. Omit to start from the first page.

Response

200 - application/json

data

ExternalCalendarAvailabilitySchema · object[]

required

A single page of data contained within this list.

Show child attributes

next_page

string

required

A URL linking to the next page of this list.

has_more

boolean

default:false

Whether there are more pages or data in this list.

type

string

default:list

Type of this object. Always list.

⌘I

List calendar availability (paginated)

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/calendar-availability/paginated/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/calendar-availability/paginated/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/calendar-availability/paginated/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/calendar-availability/paginated/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/calendar-availability/paginated/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/calendar-availability/paginated/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "appointment_kind_id": 123,
      "calendar_resource_id": 123,
      "calendar_resource_name": "<string>",
      "slots": [
        {
          "end_datetime": "2023-11-07T05:31:56Z",
          "start_datetime": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

List calendar availability (paginated)

Authorizations

Query Parameters

Response