Skip to main content
GET
/
patients
/
{patient_id}
Get Patient Details
curl --request GET \
  --url https://backend.claros.health/patients/{patient_id}/ \
  --header 'X-API-Key: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "dob": "2023-12-25",
  "sex": "<string>",
  "additional_variables": {},
  "pdf_file": "<string>",
  "pdf_json_cache": {},
  "variables": [
    {
      "id": 123,
      "name": "<string>",
      "value": "<string>",
      "note": "<string>",
      "pdf_page": 123,
      "highlight": {
        "x1": 123,
        "y1": 123,
        "x2": 123,
        "y2": 123
      }
    }
  ],
  "date_variables": [
    {
      "id": 123,
      "patient_id": 123,
      "patient_name": "<string>",
      "date_variable_id": 123,
      "date_variable_name": "<string>",
      "value": "2023-12-25",
      "note": "<string>",
      "pdf_page": 123,
      "highlight": {
        "x1": 123,
        "y1": 123,
        "x2": 123,
        "y2": 123
      }
    }
  ]
}
This endpoint requires authentication. Include your API key in the request headers as X-API-Key.

​
Description

Retrieves detailed information about a specific patient, including their variables, date variables, and PDF information.

​
Path Parameters

​
patient_id
integer
required
The ID of the patient to retrieve

​
Response

​
id
integer
The unique identifier of the patient
​
name
string
The name of the patient
​
dob
string
The date of birth in ISO 8601 format (YYYY-MM-DD)
​
sex
string
The patient’s sex
​
additional_variables
object
Any additional patient-specific variables
​
pdf_file
string
The URL of the patient’s PDF file, if one exists
​
pdf_json_cache
object
Cached JSON data from the patient’s PDF
​
variables
array
Array of numerical variables associated with the patient
​
date_variables
array
Array of date variables associated with the patient

​
Example Response

{
  "id": 1,
  "name": "John Doe",
  "dob": "1980-01-01",
  "sex": "M",
  "additional_variables": {},
  "pdf_file": "https://storage.example.com/pdfs/patient1.pdf",
  "pdf_json_cache": {},
  "variables": [
    {
      "id": 1,
      "name": "Systolic Blood Pressure",
      "value": "120",
      "note": "Taken during morning checkup",
      "pdf_page": 2,
      "highlight": {
        "x1": 100,
        "y1": 200,
        "x2": 300,
        "y2": 250
      }
    }
  ],
  "date_variables": [
    {
      "id": 1,
      "name": "Last Visit",
      "value": "2024-03-15",
      "note": "Regular checkup",
      "pdf_page": 2,
      "highlight": {
        "x1": 150,
        "y1": 300,
        "x2": 350,
        "y2": 350
      }
    }
  ]
}

​
Error Responses

​
401
object
Authentication required. Make sure you’ve included a valid API key in the request headers.
​
403
object
Unauthorized access to patient data. You can only access patients associated with your account.
​
404
object
Patient not found. The specified patient ID does not exist.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
patient_id
integer
required

The ID of the patient to retrieve

Response

Patient details retrieved successfully

​
id
integer

The unique identifier of the patient

​
name
string

The name of the patient

​
dob
string<date>

The date of birth in ISO 8601 format

​
sex
string

The patient's sex

​
additional_variables
object

Any additional patient-specific variables

​
pdf_file
string

The URL of the patient's PDF file

​
pdf_json_cache
object

Cached JSON data from the patient's PDF

​
variables
object[]

Array of numerical variables associated with the patient

​
date_variables
object[]

Array of date variables associated with the patient