Skip to main content
GET
List creatives

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. A value above the maximum is rejected with 400 rather than silently reduced to it — v3 rejects unusable input instead of substituting its own, the same way it rejects unrecognized query parameters. The server may still return fewer items than requested, so treat meta.nextCursor as the only end-of-collection signal rather than comparing the page length against limit.

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

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

filter[name][contains]
string

Case-insensitive substring match on the creative's name.

Maximum string length: 512
filter[type][in]
enum<string>[]

Creative types to include. Repeat the parameter or use comma-separated values.

The kind of creative, which fixes its content and styling shape. A feedbackButton is a tab on an edge of the page that always opens its Destination; a banner is a bar across the top or bottom of the page with a message and an optional button. Fixed at creation: it can never change.

Available options:
feedbackButton,
banner
filter[displayStatus][in]
enum<string>[]

Derived statuses to include. Repeat the parameter or use comma-separated values. Omit for every status but archived.

What the creative is doing now, derived in this order: archived when archived; draft and closed (status completed) when the author said so; closed when the schedule's endAt has passed; paused when the author paused it; scheduled before the schedule's startAt; paused when its Destination survey isn't active (not inProgress, or archived); otherwise active.

Available options:
draft,
scheduled,
active,
paused,
closed,
archived
surveyId
string<cuid2>

Only creatives whose Destination is this survey.

sortBy
enum<string>
default:updatedAt

Sort order: updatedAt and createdAt newest first, name alphabetically. The cursor is bound to it.

Available options:
updatedAt,
createdAt,
name

Response

Creatives retrieved successfully

data
object[]
required

A creative: a page element the web SDK renders on the customer's site next to surveys, with its own content, look, display rules and schedule. type selects the content and styling shape: switch on it.

The writable groups are name, status, defaultLanguage with languages, autoSelectLanguage, content, styling, destination, distribution and schedule; a PATCH replaces each group it sends as a whole. displayStatus, displayStatusReason, warnings, the timestamps, creator and destination.opensAs are read-only.

meta
object
required

The list meta for creatives — pagination only.