list

List all collections within an organization

HTTP Request

GET /api/v1/organizations/:organizationId/collections

Parameters

Parameter

Type

Description

Path parameters

:organizationId

integer | string

Organization shortName or persistent numeric identifier for 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.

Data.overview — You must have overview access to at least one dataset in the collection

Public — At least one dataset in the collection must be publicly visible.

Response

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

{
"nextPageToken": string,
"collections": [
{
"id": integer,
"name": string,
"createdAt": string(timestamp),
"updatedAt": string(timestamp),
"datasetCount": integer,
}
]
}

Examples

# List 10 collections belonging to the StanfordPHS organization
curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://redivis.com/api/organizations/stanfordphs/collections?maxResults=10"