API ReferenceStudies

List all studies in a project

View as MarkdownOpen in Claude
List all of your studies in a project. For projects with a large number of studies, pagination can be used to optimize the response size and performance. To paginate, use the `page`, `page_size` and `ordering` query parameters. For example, to retrieve the first 10 studies, use `/api/v1/projects/{project_id}/studies/?page=1&page_size=10&ordering=-date_created`.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

project_idstringRequired
Project id

Query parameters

pageintegerOptional
The page number to retrieve.
page_sizeintegerOptional
The number of studies to retrieve per page.
orderingstringOptional

The ordering of the studies. Use -date_created to order by date created in descending order.

Response

List of studies for the given project
resultslist of objects
List of all studies matching the criteria.

Errors

4XX
Client Request Error