Calendars

List all calendar designations

Returns a list of all calendar designations across all clinics in the organization. The calendar designations are sorted by creation date, with the most recent appearing first.

A calendar designation defines a time window on a specific resource’s schedule that is reserved for particular appointment kinds (e.g., a block reserved exclusively for surgeries or dental cleanings). Designations can be one-off or recurring.

If a designation is an exception to a recurring series, it references the parent recurring designation.

GET

ext

calendar-designations

List all calendar designations

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

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

fetch('https://connect.vetcove.com/ext/v2/calendar-designations/', 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-designations/",
  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-designations/"

	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-designations/")

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": [
    {
      "calendar_resource_id": 123,
      "clinic_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "deleted": "2023-11-07T05:31:56Z",
      "duration_minutes": 123,
      "end_datetime": "2023-11-07T05:31:56Z",
      "id": 123,
      "is_deleted": true,
      "is_recurring": true,
      "modified": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "start_datetime": "2023-11-07T05:31:56Z",
      "appointment_kind_ids": [
        123
      ],
      "recurrence": {
        "frequency": "YEARLY",
        "interval": 123,
        "days_of_week": [
          "MO"
        ],
        "end_after_occurrences": 123,
        "end_date": "2023-12-25"
      },
      "recurrence_excluded_datetimes": [
        "2023-11-07T05:31:56Z"
      ],
      "recurring_designation_id": 123,
      "rrule": "<string>"
    }
  ],
  "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

ids

integer[] | null

When provided, filters to objects with these IDs.

ending_before

integer | null

A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as starting_after.

starting_after

integer | null

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limit

integer

default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100

cursor

string | null

A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with starting_after or ending_before parameters.

modified__gte

string<date-time> | null

Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with starting_after or ending_before parameters.

modified__lte

string<date-time> | null

Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with starting_after or ending_before parameters.

is_deleted

enum<string>

default:FALSE

When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.

Available options:

FALSE,

TRUE,

ALL

clinic_id

integer | null

Filter to calendar designations belonging to the clinic with this ID.

calendar_resource_id

integer | null

Filter to calendar designations assigned to the calendar resource with this ID.

Response

200 - application/json

data

ExternalCalendarDesignationSchema · 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 all calendar designations

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

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

fetch('https://connect.vetcove.com/ext/v2/calendar-designations/', 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-designations/",
  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-designations/"

	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-designations/")

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": [
    {
      "calendar_resource_id": 123,
      "clinic_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "deleted": "2023-11-07T05:31:56Z",
      "duration_minutes": 123,
      "end_datetime": "2023-11-07T05:31:56Z",
      "id": 123,
      "is_deleted": true,
      "is_recurring": true,
      "modified": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "start_datetime": "2023-11-07T05:31:56Z",
      "appointment_kind_ids": [
        123
      ],
      "recurrence": {
        "frequency": "YEARLY",
        "interval": 123,
        "days_of_week": [
          "MO"
        ],
        "end_after_occurrences": 123,
        "end_date": "2023-12-25"
      },
      "recurrence_excluded_datetimes": [
        "2023-11-07T05:31:56Z"
      ],
      "recurring_designation_id": 123,
      "rrule": "<string>"
    }
  ],
  "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 all calendar designations

Authorizations

Query Parameters

Response