---
title: "GET /api/appointment_templates"
method: GET
path: "/api/appointment_templates"
tags: ["Clinical"]
---

# GET /api/appointment_templates

`GET /api/appointment_templates`

Retrieve or search appointment templates for a doctor's calendar

## Query parameters

- `available` string — The date for which the template is available. The week day will be set to the week day of the date specified. Format: yyyy-mm-dd
- `week_days` integer[] — Array of integers that indicate week days in ISO Format (`0` = Monday, ..., `6` = Sunday)
- `cursor` string — The pagination cursor value.
- `page_size` integer — Number of results to return per page.
- `profile` integer
- `office` integer
- `doctor` integer

## Response `200`

OK

- object — Paginated Result
  - `previous` string — Previous paginated page
  - `data` AppointmentTemplate[] — result data
    - `profile` integer, required — ID of the appointment profile to default to
    - `scheduled_time` string, required
    - `archived` boolean — Indicats that the object has been soft-deleted and should not be used
    - `week_days` integer[] — Array of integers that indicate week days (`0` = Monday, ..., `6` = Sunday)
    - `office` integer, required
    - `open_slots` object[] — Array of time intervals during which the template is available. Only computed if the available and verbose query parameters are passed. Note that only slots long enough to fit an appointment with the corresponding profile are included.
      - `start` string
      - `end` string
    - `date_end` string
    - `date_start` string
    - `exam_room` integer, required — **1-based** index for the exam room
    - `duration` integer — Length of an appointment in minutes
    - `id` integer
  - `next` string — Next Paginated page

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Permission Denied
- `404` — Not Found
- `405` — Method Not Allowed
- `500` — Internal Server Error

---

[API](https://skmtc.net/drchrono/apis/untitled-api.md) · [All operations](https://skmtc.net/drchrono/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drchrono/untitled-api/versions/e595797fe800/schema)