Studies

List studies

Studies in the organization your credential acts on, newest first, limited to the workspaces a user-delegated token can reach. Archived and deleted studies are omitted, as are the studies the Simulations product runs against digital twins. Filters combine with AND.

A row carries the study's settings, question_count and has_screener — not the guide itself. Read one study to get its questions and screener.

Requires the studies:read scope, on a user-delegated token or a partner credential.

get/v2/studies/

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/studies/
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://outset.ai/oauth/authorize, token URL https://api.outset.ai/users/oauth/token/, scopes: studies:read)
    • HTTP bearer

Query parameters

activeboolean

true for published studies, false for the rest. Any other value is refused.

created_afterstring date-time

Return studies created at or after this instant (ISO 8601).

created_beforestring date-time

Return studies created strictly before this instant (ISO 8601).

cursorstring
page_sizeinteger
projectstring uuid

Return only studies in this project.

studystring uuid

Return only this study. A study outside this organization returns no rows.

workspacestring uuid

Return only studies in this workspace. Workspace identifiers come from GET /v2/me/ for a user-delegated token and from the organization response for a partner; workspaces are not otherwise addressable here.

Response

next_cursorstring nullable required
has_moreboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.