Fetch one patient by Olira-assigned id.
GET
/
v1
/
patients
/
{patient_id}
import olira
olira.init(api_key="YOUR_API_KEY")
patient = olira.get_patient(patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82")
print(patient.status)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var patient = OliraModule.GetPatient(patientId: "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82");
Console.WriteLine(patient.Status);
GET /v1/patients/8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82
Authorization: Bearer YOUR_API_KEY
Patient(
id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
sex="unknown",
timezone="UTC",
status="active",
phone_number=None,
date_of_birth=None,
created_at="2026-01-10T08:00:00Z",
external_identifiers=[],
metadata=None,
)
{
"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_patient(patient_id: str) -> Patient
OliraModule.GetPatient(string patientId) // -> Patient
api:manage-patients
Parameters
str
required
Olira patient id.
Returns
Patient
str
Olira patient id.
str | None
Given name.
str | None
Family name.
str | None
Sex/gender.
str
IANA timezone.
str
Status.
str | None
Email.
str | None
Phone.
str | None
DOB.
str | None
Created at.
list[ExternalIdentifier]
External ids. Each carries integration_id (str | None) — platform-assigned, read-only; None if you supplied the identifier yourself.
dict[str, Any] | None
Metadata.
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")
patient = olira.get_patient(patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82")
print(patient.status)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var patient = OliraModule.GetPatient(patientId: "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82");
Console.WriteLine(patient.Status);
GET /v1/patients/8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82
Authorization: Bearer YOUR_API_KEY
Patient(
id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
sex="unknown",
timezone="UTC",
status="active",
phone_number=None,
date_of_birth=None,
created_at="2026-01-10T08:00:00Z",
external_identifiers=[],
metadata=None,
)
{
"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")
patient = olira.get_patient(patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82")
print(patient.status)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var patient = OliraModule.GetPatient(patientId: "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82");
Console.WriteLine(patient.Status);
GET /v1/patients/8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82
Authorization: Bearer YOUR_API_KEY
Patient(
id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
sex="unknown",
timezone="UTC",
status="active",
phone_number=None,
date_of_birth=None,
created_at="2026-01-10T08:00:00Z",
external_identifiers=[],
metadata=None,
)
{
"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"
}