get

HTTP Request

GET /api/v1/organizations/:organizationShortName/studies/:studyId

Parameters

Parameter

Type

Description

Path parameters

:organizationShortName

string

shortName of the organization

:studyId

integer

ID of the study

Request body

Do not supply a request body with this method.

Authorization

Required; the requester must be an administrator of the organization. An API access token can be specified in the request header or as a query parameter (read more).

Response

If successful, this method returns a response body with the following structure:

{
"kind": "study",
"id": integer,
"name": string,
"status": string("approved"|"expired"|"pending"|"rejected")
"url": string,
"createdAt": string(timestamp),
"updatedAt": string(timestamp),
"submittedAt": string(timestamp),
"approvedAt": string(timestamp),
"rejectedAt": string(timestamp),
"expiresAt": string(date),
"datasetCount": integer,
"userCount": integer,
"owner": {
"kind": "user",
"userName": string,
},
"users": {
"kind": "user",
"userName": string,
},
"datasets": {
"kind": "dataset",
"id": integer,
"name": string,
"url": string
},
}