Paginated list of patients in your organization.
GET
/
v1
/
patients
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)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.ListPatients(limit: 50, offset: 0);
foreach (var p in result.Patients)
Console.WriteLine($"{p.Id} {p.Email}");
GET /v1/patients?limit=50&offset=0
Authorization: Bearer YOUR_API_KEY
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,
)
{
"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.list_patients(
limit: int = 100,
offset: int = 0,
external_system: str | None = None,
external_value: str | None = None,
integration_id: str | None = None,
) -> PatientListResult
OliraModule.ListPatients(
int limit = 100,
int offset = 0,
string? externalSystem = null,
string? externalValue = null,
string? integrationId = null,
) // -> PatientListResult
api:manage-patients
Filters compose as AND on the same identifier: external_system alone finds every patient with an identifier for that system; external_system + external_value finds every patient with that exact identifier (usually one, but not guaranteed — two integration instances of the same system can share a value, so add integration_id for exactly one instance); integration_id alone finds every patient linked to that integration instance. external_value requires external_system.
Parameters
int
default:"100"
Page size.
int
default:"0"
Pagination offset.
str | None
Filter: every patient with an identifier for this system (e.g. epic). Combine with external_value for that exact identifier (usually one; add integration_id if two instances of the same system can share a value).
str | None
Filter: external id value. Requires external_system.
str | None
Filter: every patient linked to this integration instance, regardless of system or value.
Returns
PatientListResult
list[Patient]
Patients in this page.
int
Total matching patients.
bool
Whether additional pages exist.
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. |
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)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.ListPatients(limit: 50, offset: 0);
foreach (var p in result.Patients)
Console.WriteLine($"{p.Id} {p.Email}");
GET /v1/patients?limit=50&offset=0
Authorization: Bearer YOUR_API_KEY
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,
)
{
"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"
}
⌘I
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)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.ListPatients(limit: 50, offset: 0);
foreach (var p in result.Patients)
Console.WriteLine($"{p.Id} {p.Email}");
GET /v1/patients?limit=50&offset=0
Authorization: Bearer YOUR_API_KEY
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,
)
{
"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"
}