Skip to navigation
APIsStudy ResourcesStudy Group Treatments

Retrieve a study group treatment

Retrieves the details of an existing study group treatment.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.
studyGroupIdstringRequiredformat: "^grp_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study group.
treatmentIdstringRequiredformat: "^tmt_[a-zA-Z0-9]{10,22}$"
The unique identifier of the treatment.

Headers

X-Studies-Api-VersionstringOptional

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The requested study-group treatment.

idstringformat: "^tmt_[a-zA-Z0-9]{10,22}$"
Unique identifier for a treatment.
typeenum or null
How the amount to administer is derived.
namestring or null<=255 characters
The name of the treatment.
labelstring<=255 characters
The label of the treatment.
external_entity_idstring or null<=50 characters
The external identifier of the treatment.
doseobject or null
The dose concentration associated with the treatment.
dose_volumeobject or null
The dose volume associated with the treatment.
stockobject or null
The stock concentration associated with the treatment.
volumeobject or null
The volume of the treatment.
metadatamap from strings to any or null
The metadata associated to the treatment.
studyobject or null
The study associated with the treatment.
study_groupobject or null
The study group associated with the treatment.
created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error