Skip to navigation
APIsStudy Code Resources

Retrieve a study code

Retrieves the details of an existing study code.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyCodeIdstringRequiredformat: "^sdc_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study code.

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 code.
idstringformat: "^sdc_[a-zA-Z0-9]{10,22}$"
Unique identifier for a study code.
titlestring
The title of the study code.
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