Sign in
V3 Surveys

List surveys

Returns surveys for the workspace. Session cookie or x-api-key.

get/api/v3/surveys

Query parameters

workspaceIdstring cuid2 required

Workspace identifier. Today: pass the environment id (the environment that contains the surveys). When Workspace replaces Environment in the data model, clients may pass workspace ids instead; resolution is centralized in workspace-context.

limitinteger

Page size (max 100)

cursorstring

Opaque cursor returned as meta.nextCursor from the previous page. Omit on the first request.

filter[name][contains]string

Case-insensitive substring match on survey name (same as in-app list filters).

filter[status][in]string[]

Survey status filter. Repeat the parameter (filter[status][in]=draft&filter[status][in]=inProgress) or use comma-separated values (filter[status][in]=draft,inProgress). Invalid values → 400.

filter[type][in]string[]

Survey type filter (link / app). Same repeat-or-comma rules as filter[status][in].

sortBy'createdAt' | 'updatedAt' | 'name' | 'relevance'

Sort order. Defaults to updatedAt. The cursor token is bound to the selected sort order.

Response

Surveys retrieved successfully

Changes