---
title: "View schedule templates (beta)"
method: GET
path: "/schedule_templates"
tags: ["Schedule Templates"]
---

# View schedule templates (beta)

`GET /schedule_templates`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/schedule_templates`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

This endpoint returns the EHR schedule templates available to a location, which are the ones belonging to the location and the ones that apply to every location of its data source. Results can be narrowed down with the optional filters.

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `name` string
- `active` boolean
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesScheduleTemplateCollectionResponseWithCursor: API_V31_Entities_ScheduleTemplate_Collection_Response_WithCursor model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesScheduleTemplate[]
    - `id` integer: Schedule template NexHealth ID
    - `name` string: The name of the schedule template
    - `color_hex` string, nullable: The color of the schedule template as a hex code
    - `active` boolean: False when the EHR has deactivated the schedule template
    - `location_id` integer, nullable: The NexHealth ID of the location the schedule template belongs to, null when it applies to every location of the data source
    - `foreign_id` string, nullable: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
  - `page_info` object: Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)