list

HTTP Request

GET /api/v1/organizations/:organizationShortName/studies
GET /api/v1/organizations/:organizationShortName/members/:userName/studies

Parameters

Parameter

Type

Description

Path parameters

:organizationShortName

string

shortName of the organization

Query parameters

maxResults

integer

Maximum number of results to return. Defaults to 25, may not exceed 100.

pageToken

string

Page token, returned by a previous call, to request the next page of results. Optional.

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": "studyList",
"nextPageToken": string,
"studies": [
{
"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,
}
}
]
}