Skip to main content
GET
/
patients
cURL
curl --request GET \
  --url https://backend.claros.health/patients \
  --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 all patients associated with the authenticated user. The response includes patient details, their variables, and date variables.

​
Response

​
id
integer
The unique identifier of the patient
​
name
string
The name of the patient
​
dob
string
The date of birth of the patient in ISO format
​
sex
string
The sex of the patient
​
additional_variables
object
Additional patient-specific variables stored as key-value pairs
​
pdf_file
string
URL to the patient’s PDF file, if available
​
pdf_json_cache
object
Cached JSON data from the patient’s PDF, if available
​
variables
array
List of variables associated with the patient
​
date_variables
array
List of date variables associated with the patient

​
Example Response

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

Authorizations

​
X-API-Key
string
header
required

Response

List of patients

​
id
integer
​
name
string
​
dob
string<date>
​
sex
string
​
additional_variables
object
​
pdf_file
string | null
​
pdf_json_cache
object
​
variables
object[]
​
date_variables
object[]