Skip to main content
GET
List surveys

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId
string<cuid2>
required

Workspace identifier. This is the canonical container ID for v3 APIs.

limit
integer
default:20

Page size (max 100)

Required range: 1 <= x <= 100
cursor
string

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

includeTotalCount
boolean
default:true

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).

Maximum string length: 512
filter[status][in]
enum<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.

Available options:
draft,
inProgress,
paused,
completed,
archived
filter[type][in]
enum<string>[]

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

Available options:
link,
app
sortBy
enum<string>

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

Available options:
createdAt,
updatedAt,
name,
relevance

Response

Surveys retrieved successfully

data
object[]
required
meta
object
required