Skip to main content
GET
/
date_variables
cURL
curl --request GET \
  --url https://backend.claros.health/date_variables \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "name": "<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 date variables associated with the authenticated user. Date variables are used to track temporal data points for patients.

​
Response

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

​
Example Response

[
  {
    "id": 1,
    "name": "Last Visit",
    "description": "Date of the patient's last office visit",
    "patient_values_count": 200
  },
  {
    "id": 2,
    "name": "Next Appointment",
    "description": "Date of the patient's next scheduled appointment",
    "patient_values_count": 180
  }
]

Authorizations

​
X-API-Key
string
header
required

Response

List of date variables

​
id
integer

The unique identifier of the date variable

​
name
string

The name of the date variable

​
description
string

A description of what the date variable represents

​
patient_values_count
integer

The number of patients that have values for this date variable