v16

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-0124102197.4 KB

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. This is the canonical container ID for v3 APIs.

limitinteger

Page size (max 100)

cursorstring

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

includeTotalCountboolean

Whether to calculate meta.totalCount for this request. Set to false on cursor-pagination follow-up requests to skip the extra count query; in that case meta.totalCount is null.

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. archived is a pseudo-status: it does not match a real survey status but includes archived (soft-deleted) surveys in the result set. Archived surveys are otherwise excluded from the default list.

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

All 24 operations