---
title: "Search the synthetic patient directory"
method: GET
path: "/api/sites/{site}/patients"
tags: ["Service workspaces"]
---

# Search the synthetic patient directory

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

## Request

- Base URL: `https://sim.animahealth.com`
- URL: `https://sim.animahealth.com/api/sites/{site}/patients`
- 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

- `q` string
- `offset` integer
- `world` string

## Response `200`

Success

- object
  - `total` integer, required
  - `items` Patient[], required
    - `death` PatientDeath
      - `date` string, date, required
      - `cause` string, required
      - `synthetic` true, required
      - `source` 'authored-synthetic-mortality-v1', required
    - `id` string, required
    - `name` string, required
    - `birthDate` string, date, required
    - `localIds` object, required
    - `conditions` string[], required
    - `needs` string[], required
    - `goals` string[], required
    - `synthetic` unknown, 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)