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

# Get schema

> Returns a subtype's full version history — materialized versions plus a still-pending request, if any.

```python theme={null}
olira.get_schema(subtype: str) -> SchemaDetail
```

**Requires scope:** `api:org-config`

## Parameters

<ParamField body="subtype" type="str" required>
  Org-native subtype to look up.
</ParamField>

## Returns

`SchemaDetail`

<ResponseField name="subtype" type="str">
  Looked-up subtype.
</ResponseField>

<ResponseField name="status" type="str">
  Aggregate status: "pending", "active", or "deprecated".
</ResponseField>

<ResponseField name="active_version" type="int | None">
  Currently active version, if any.
</ResponseField>

<ResponseField name="versions" type="list[SchemaVersion]">
  Every known version, oldest first.
</ResponseField>

<ResponseField name="versions[].version" type="int">
  Version number.
</ResponseField>

<ResponseField name="versions[].status" type="str">
  "pending", "active", or "deprecated".
</ResponseField>

<ResponseField name="versions[].source" type="str">
  "registration" (not yet materialized) or "materialized".
</ResponseField>

<ResponseField name="versions[].payload_schema" type="dict | None">
  JSON Schema for this version, if known.
</ResponseField>

<ResponseField name="versions[].mapping_summary" type="dict | None">
  Target count + unmapped\_fields\_policy for this version's mapping, if known.
</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")
  detail = olira.get_schema(subtype="widget_ping")
  for v in detail.versions:
      print(v.version, v.status, v.source)
  ```

  ```http HTTP theme={null}
  GET /v1/schemas/widget_ping
  Authorization: Bearer YOUR_API_KEY
  ```
</RequestExample>

<ResponseExample>
  ```python 200 theme={null}
  SchemaDetail(
      subtype="widget_ping",
      status="pending",
      active_version=None,
      versions=[
          SchemaVersion(
              version=1,
              status="pending",
              source="registration",
              payload_schema=None,
              mapping_summary=None,
              description="Widget sensor ping events",
              created_at="2026-07-13T17:43:55Z",
              created_by="member_123",
              submission_mode="assisted",
              self_check=None,
              registration_id="6a5523da0d094fdeed36f566",
          ),
      ],
  )
  ```

  ```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>