---
title: "Appointments"
method: GET
path: "/api/nhs/appointments"
tags: ["NHS-shaped adapters"]
---

# Appointments

`GET /api/nhs/appointments`

## Request

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

Capacity-backed booking. Requires gp scope. Simplified JSON projection, not a certified NHS API or full FHIR implementation. At most 100 workflow resources are returned; total may be larger. PDS/ODS FHIR search/read routes are documented separately.

## Query parameters

- `patient` string
- `q` string
- `world` string

## Response `200`

Success

- Bundle
  - `resourceType` 'Bundle', required
  - `type` 'searchset', required
  - `total` integer
  - `link` object[]
    - `relation` string, required
    - `url` string, required
  - `entry` object[], required
    - `fullUrl` string
    - `resource` object, required
    - `search` object
      - `mode` 'match', required

## 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)