v1

latestOpenAPI 3.0.1GNU General Public License v3 (GPL-3)2026-07-145265194.5 KB

studies

Get Study

get/v4/study

Query parameters

causeVariableNamestring

Deprecated: Name of the hypothetical predictor variable. Ex: Sleep Duration

effectVariableNamestring

Deprecated: Name of the outcome variable of interest. Ex: Overall Mood

causeVariableIdinteger

Variable id of the hypothetical predictor variable. Ex: 1398

effectVariableIdinteger

Variable id of the outcome variable of interest. Ex: 1398

predictorVariableNamestring

Name of the hypothetical predictor variable. Ex: Sleep Duration

outcomeVariableNamestring

Name of the outcome variable of interest. Ex: Overall Mood

userIdnumber

User's id

clientIdstring

Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do

includeChartsboolean

Highcharts configs that can be used if you have highcharts.js included on the page. This only works if the id or name query parameter is also provided.

recalculateboolean

Recalculate instead of using cached analysis

studyIdstring

Client id for the study you want

Response

Successful operation

typestring required

Ex: population, cohort, or individual

userIdinteger

The user id of the principal investigator or subject if an individual studies

idstring

ID of the cohort study which is necessary to allow participants to join

causeVariableNamestring

Ex: Sleep Quality

effectVariableNamestring

Ex: Overall Mood

joinedboolean

True if you are sharing your data with this study