Skip to navigation
APIsStudy ResourcesStudy Groups

Retrieve a study group

Retrieves the details of an existing study group. You need only supply the unique study group identifier that was returned upon study group creation.

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.

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.
idstringformat: "^grp_[a-zA-Z0-9]{10,22}$"
Unique identifier for a study group.
namestring<=255 characters
The name of the study group.
nointeger or null
The sequence number of the study group.
colorstring or null<=255 characters
The color of the study group.
max_animalsinteger or null
The maximum number of animals allowed in the study group. Null when the group is uncapped.
controlboolean
Indicates this group is a control.
metadatamap from strings to any or null
The metadata associated to the study group.
studyobject or null
The study of the study group.
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