v1

latestSwagger 2.02026-07-1756146155.9 KB
study

List all studies (collections of items)

List studies, optionally filtered by a range of properties. Any number of properties can be combined by listing them one after the other in the form '/study/list/{filter}/{value}/{filter}/{value}/...' Returns an array with all studies that match the constraints.

get/study/list/{filters}

Path parameters

filtersstring required

Any combination of these filters /main_entity_type/{type} - only return studies collecting entities of a given type (e.g. 'task' or 'run'). /uploader/{ids} - return only evaluations uploaded by specific users, specified as a comma-separated list of user IDs, e.g. ''1,2,3'' /limit/{limit}/offset/{offset} - returns only {limit} results starting from result number {offset}. Useful for paginating results. With /limit/5/offset/10, results 11..15 will be returned. Both limit and offset need to be specified.

Query parameters

api_keystring

API key to authenticate the user

Response

A list of studies