---
title: "The diary for a day or a range"
method: GET
path: "/v1/schedule"
---

# The diary for a day or a range

`GET /v1/schedule`

## Request

- Base URL: `https://api.octapi.app`
- URL: `https://api.octapi.app/v1/schedule`
- Auth: HTTP bearer

## Query parameters

- `date` string
- `from` string
- `to` string

## Response `200`

Default Response

- object
  - `appointments` object[], required
    - `id` string, required
    - `service` string, required
    - `provider` string, nullable, required
    - `starts_at` string, required
    - `ends_at` string, required
    - `status` string, required
    - `notes` string, nullable, required
    - `outcome_at` string, nullable, required
    - `outcome_by` string, nullable, required
    - `used_package` boolean, required
    - `display_name` string, nullable, required
    - `address` string, nullable, required
    - `conversation_id` string, nullable, required
  - `timezone` string

---

[API](https://skmtc.dev/octapi/apis/octapi-api.md) · [All operations](https://skmtc.dev/octapi/apis/octapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/octapi/apis/octapi-api/revisions/580afda787d2?raw)