---
title: "Read a day of appointments and appointment sessions"
method: GET
path: "/api/sites/{site}/appointments"
tags: ["Service workspaces"]
---

# Read a day of appointments and appointment sessions

`GET /api/sites/{site}/appointments`

## Request

- Base URL: `https://sim.animahealth.com`
- URL: `https://sim.animahealth.com/api/sites/{site}/appointments`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - API key in cookie `sim_session`

## Path parameters

- `site` 'control' | 'gp' | 'hospital' | 'community' | 'pharmacy' | 'diagnostics' | 'referrals' | 'wearables', required

## Query parameters

- `date` string, date, required
- `world` string

## Response `200`

Success

- object
  - `appointments` Resource[], required
    - `id` string, required
    - `patientId` string
    - `kind` string, required
    - `title` string, required
    - `status` string, required
    - `owner` string, required
    - `visibleTo` string[], required
    - `priority` 'routine' | 'urgent', required
    - `createdAt` number, required: Simulation Unix timestamp in milliseconds.
    - `dueAt` number: Simulation Unix timestamp in milliseconds.
    - `data` object, required: Kind-specific payload. Hospital notes, medication orders and blood-test orders use the named schemas; the full workspace payload is returned without projection.
    - `version` integer, required
    - `provenance` object
      - `created` RecordChange, required
        - `actor` object, required
          - `kind` 'team' | 'operator' | 'simulation', required
          - `name` string, required
        - `source` string, required
        - `action` string, required
        - `time` number, required: Simulation Unix timestamp in milliseconds.
        - `version` integer, required
      - `changes` RecordChange[], required
        - `actor` object, required
          - `kind` 'team' | 'operator' | 'simulation', required
          - `name` string, required
        - `source` string, required
        - `action` string, required
        - `time` number, required: Simulation Unix timestamp in milliseconds.
        - `version` integer, required
      - `recovery` object
  - `patients` object[], required
    - `id` string, required
    - `name` string, required
  - `sessions` Resource[], required
    - `id` string, required
    - `patientId` string
    - `kind` string, required
    - `title` string, required
    - `status` string, required
    - `owner` string, required
    - `visibleTo` string[], required
    - `priority` 'routine' | 'urgent', required
    - `createdAt` number, required: Simulation Unix timestamp in milliseconds.
    - `dueAt` number: Simulation Unix timestamp in milliseconds.
    - `data` object, required: Kind-specific payload. Hospital notes, medication orders and blood-test orders use the named schemas; the full workspace payload is returned without projection.
    - `version` integer, required
    - `provenance` object
      - `created` RecordChange, required
        - `actor` object, required
          - `kind` 'team' | 'operator' | 'simulation', required
          - `name` string, required
        - `source` string, required
        - `action` string, required
        - `time` number, required: Simulation Unix timestamp in milliseconds.
        - `version` integer, required
      - `changes` RecordChange[], required
        - `actor` object, required
          - `kind` 'team' | 'operator' | 'simulation', required
          - `name` string, required
        - `source` string, required
        - `action` string, required
        - `time` number, required: Simulation Unix timestamp in milliseconds.
        - `version` integer, required
      - `recovery` object

## Other responses

- `400`: Invalid input or unsupported workflow
- `401`: Missing or invalid credentials
- `403`: Scope, origin or operator restriction
- `404`: Unknown resource
- `409`: Stale version, invalid transition or unavailable capacity
- `413`: Request exceeds this operation's body-size limit
- `429`: Deployment has reached its 5,000-team capacity
- `500`: Internal simulation error

---

[API](https://skmtc.dev/animahealth/apis/nhs-sim-api.md) - [All operations](https://skmtc.dev/animahealth/apis/nhs-sim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/animahealth/apis/nhs-sim-api/revisions/c7803d7a3e58?raw)