Surveys

Get a survey by ID

Retrieves a single survey by its unique identifier.

GET

/v2/surveys/{id}

Get a survey by ID

curl --request GET \
  --url https://do.featurebase.app/v2/surveys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "createdAt": "2024-11-24T18:49:16.755Z",
  "description": "Measure what we can improve",
  "id": "6743752ca81ae59d25cf834b",
  "isActive": true,
  "object": "survey",
  "organization": "5febde12dc56d60012d47db6",
  "pages": [],
  "responseCount": 85,
  "targeting": {
    "css": [
      {
        "value": ".feedback-button"
      }
    ],
    "loginRequired": false,
    "segmentIds": [
      "6636438b7fcdc515999042eb"
    ],
    "url": [
      {
        "id": "674375cfd8bf964ec2562cdc",
        "matchType": "contains",
        "value": "/dashboard/posts"
      }
    ]
  },
  "title": "Get feedback for Feedback module",
  "updatedAt": "2025-04-10T08:58:51.148Z"
}

Returns the survey object if found in your organization.

Response

Returns a survey object with:

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

Survey Pages

Each page represents a question or screen in the survey:

type - Page type (text, link, rating, multiple-choice)
title - Question title
description - Optional description
logic - Conditional logic rules
defaultAction - Default action when no logic matches

Errors

404 - Survey not found in your organization

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

Survey unique identifier

Ejemplo: 6743752ca81ae59d25cf834b

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Ejemplo: 2026-08-19.orbit

Respuesta

Success

createdAtstringobligatorio

ISO 8601 timestamp when created

Ejemplo: 2024-11-24T18:49:16.755Z

descriptionstring

Survey description

Ejemplo: Measure what we can improve

idstringobligatorio

Unique identifier

Ejemplo: 6743752ca81ae59d25cf834b

isActivebooleanobligatorio

Whether the survey is active

Ejemplo: true

objectenum<string>obligatorio

Object type identifier

Opciones disponibles: survey

Ejemplo: survey

organizationstringobligatorio

Organization ID

Ejemplo: 5febde12dc56d60012d47db6

pagesobject[]obligatorio

Survey pages

Mostrar child attributes

responseCountnumberobligatorio

Number of responses

Ejemplo: 85

targetingobject

Targeting configuration

Mostrar child attributes

titlestringobligatorio

Survey title

Ejemplo: Get feedback for Feedback module

updatedAtstringobligatorio

ISO 8601 timestamp when last updated

Ejemplo: 2025-04-10T08:58:51.148Z

¿Aún necesitas ayuda? Pregunta al equipo