Skip to main content
Surveys

List surveys

Returns all surveys configured in your Featurebase organization.

GET
/v2/surveys

Query Parameters

  • limit - Number of items to return (1-100, default 10)
  • cursor - Cursor for pagination
  • type - Filter by survey page type (text, link, rating, multiple-choice)
  • isActive - Filter by active status

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of survey objects
  • nextCursor - Cursor for next page (null if no more results)

Survey Object

Each survey includes:

  • id - Unique identifier
  • title - Survey title
  • description - Survey description
  • isActive - Whether the survey is active
  • responseCount - Number of responses received
  • targeting - Targeting configuration (segments, URLs, CSS selectors)
  • pages - Array of survey pages/questions
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

limitintegerquerydefault:10

A limit on the number of objects to be returned, between 1 and 100.

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page.

Maximum string length: 512
Example: eyJpZCI6IjY3NDM3NTJjYTgxYWU1OWQyNWNmODM0YiJ9
typeenum<string>query

Filter by survey page type

Available options: text, link, rating, multiple-choice
Example: rating
isActiveboolean | nullquery

Filter by active status

Example: true

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of surveys

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team