> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olira.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List patients

> Paginated list of patients in your organization.

```python theme={null}
olira.list_patients(
    limit: int = 100,
    offset: int = 0,
    external_system: str | None = None,
    external_value: str | None = None,
) -> PatientListResult
```

**Requires scope:** `api:manage-patients`

Optionally filter by a single external identifier pair.

## Parameters

<ParamField body="limit" type="int" default="100">
  Page size.
</ParamField>

<ParamField body="offset" type="int" default="0">
  Pagination offset.
</ParamField>

<ParamField body="external_system" type="str | None">
  Filter: external id system name.
</ParamField>

<ParamField body="external_value" type="str | None">
  Filter: external id value (use with external\_system).
</ParamField>

## Returns

`PatientListResult`

<ResponseField name="patients" type="list[Patient]">
  Patients in this page.
</ResponseField>

<ResponseField name="total" type="int">
  Total matching patients.
</ResponseField>

<ResponseField name="has_more" type="bool">
  Whether additional pages exist.
</ResponseField>

## Raises

| Exception         | When                                                                                                                  |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| `AuthError`       | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.                                      |
| `ValidationError` | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).   |
| `ServerError`     | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status\_code when applicable. |
| `RateLimitError`  | HTTP 429 — rate limited; check retry\_after (seconds).                                                                |
| `NetworkError`    | Connection timeout, DNS failure, or read error after retries.                                                         |

<RequestExample>
  ```python Python theme={null}
  import olira

  olira.init(api_key="YOUR_API_KEY")
  result = olira.list_patients(limit=50, offset=0)
  for p in result.patients:
      print(p.id, p.email)
  ```

  ```http HTTP theme={null}
  GET /v1/patients?limit=50&offset=0
  Authorization: Bearer YOUR_API_KEY
  ```
</RequestExample>

<ResponseExample>
  ```python 200 theme={null}
  PatientListResult(
      patients=[
          Patient(
              id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
              email="ada@example.com",
              first_name="Ada",
              last_name="Lovelace",
              sex="unknown",
              timezone="UTC",
              status="active",
              phone_number=None,
              date_of_birth=None,
              created_at=None,
              external_identifiers=[],
              metadata=None,
          ),
      ],
      total=128,
      has_more=True,
  )
  ```

  ```json 401 theme={null}
  {
    "error": true,
    "status_code": 401,
    "error_type": "authentication_error",
    "message": "Could not validate credentials",
    "details": [
      {
        "type": "authentication_error",
        "message": "Could not validate credentials"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 403 theme={null}
  {
    "error": true,
    "status_code": 403,
    "error_type": "authorization_error",
    "message": "Insufficient OAuth scope for this endpoint",
    "details": [
      {
        "type": "authorization_error",
        "message": "Insufficient OAuth scope for this endpoint"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 404 theme={null}
  {
    "error": true,
    "status_code": 404,
    "error_type": "not_found_error",
    "message": "Patient not found",
    "details": [
      {
        "type": "not_found_error",
        "message": "Patient not found"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 422 theme={null}
  {
    "error": true,
    "status_code": 422,
    "error_type": "validation_error",
    "message": "Request validation failed (1 error)",
    "details": [
      {
        "type": "missing",
        "message": "Field required",
        "field": "patient_id",
        "location": ["body", "patient_id"],
        "input_value": null
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 429 theme={null}
  {
    "error": true,
    "status_code": 429,
    "error_type": "server_error",
    "message": "Rate limit exceeded",
    "details": [
      {
        "type": "rate_limit",
        "message": "Too many requests; retry after backoff"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 500 theme={null}
  {
    "error": true,
    "status_code": 500,
    "error_type": "internal_server_error",
    "message": "An internal server error occurred",
    "details": [
      {
        "type": "internal_server_error",
        "message": "An unexpected error occurred while processing your request"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```
</ResponseExample>