Skip to main content
GET
/
variables
cURL
curl --request GET \
  --url https://backend.claros.health/variables \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "units": "<string>",
    "description": "<string>",
    "patient_values_count": 123
  }
]
This endpoint requires authentication. Include your API key in the request headers as X-API-Key.

​
Description

Retrieves all variables associated with the authenticated user. Variables are reusable data points that can be associated with multiple patients.

​
Response

​
id
integer
The unique identifier of the variable
​
name
string
The name of the variable
​
units
string
The units of measurement for the variable
​
description
string
A description of what the variable represents
​
patient_values_count
integer
The number of patients that have values for this variable

​
Example Response

[
  {
    "id": 1,
    "name": "Systolic Blood Pressure",
    "units": "mmHg",
    "description": "Systolic and diastolic blood pressure measurements",
    "patient_values_count": 150
  },
  {
    "id": 2,
    "name": "Heart Rate",
    "units": "bpm",
    "description": "Resting heart rate in beats per minute",
    "patient_values_count": 145
  }
]

Authorizations

​
X-API-Key
string
header
required

Response

List of variables

​
id
integer
​
name
string
​
units
string
​
description
string
​
patient_values_count
integer