Skip to main content
GET
/
v1
/
schemas
/
{subtype}
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)

GET /v1/schemas/widget_ping
Authorization: Bearer YOUR_API_KEY

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",
        ),
    ],
)

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

olira.get_schema(subtype: str) -> SchemaDetail
Requires scope: api:org-config

​
Parameters

​
subtype
str
required
Org-native subtype to look up.

​
Returns

SchemaDetail
​
subtype
str
Looked-up subtype.
​
status
str
Aggregate status: “pending”, “active”, or “deprecated”.
​
active_version
int | None
Currently active version, if any.
​
versions
list[SchemaVersion]
Every known version, oldest first.
​
versions[].version
int
Version number.
​
versions[].status
str
“pending”, “active”, or “deprecated”.
​
versions[].source
str
“registration” (not yet materialized) or “materialized”.
​
versions[].payload_schema
dict | None
JSON Schema for this version, if known.
​
versions[].mapping_summary
dict | None
Target count + unmapped_fields_policy for this version’s mapping, if known.

​
Raises

ExceptionWhen
AuthErrorHTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
ValidationErrorHTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).
ServerErrorHTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
RateLimitErrorHTTP 429 — rate limited; check retry_after (seconds).
NetworkErrorConnection timeout, DNS failure, or read error after retries.
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)

GET /v1/schemas/widget_ping
Authorization: Bearer YOUR_API_KEY

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",
        ),
    ],
)

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}