Outbound

List responses to an Outbound survey

Returns the individual responses to a survey, newest first, with the answers to every page.

GET

/v2/outbound/messages/{outboundMessageId}/survey_responses

curl --request GET \
  --url 'https://do.featurebase.app/v2/outbound/messages/{outboundMessageId}/survey_responses?responseId=%3Cstring%3E&pageId=%3Cstring%3E&cursor=%3Cstring%3E&limit=20&start=%3Cstring%3E&end=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar'

{
  "data": [
    {
      "createdAt": "2026-09-01T09:30:00.000Z",
      "id": "6457e3ff70afca5d8c27dccc",
      "object": "survey_response",
      "responses": [
        {
          "createdAt": "2026-09-03T12:00:00.000Z",
          "id": "6457e3ff70afca5d8c27dcc2",
          "pageId": "6457e3ff70afca5d8c27dcc1",
          "type": "rating",
          "updatedAt": "2026-09-03T12:00:00.000Z",
          "value": 9
        }
      ],
      "user": {
        "email": "jane@example.com",
        "id": "6457e3ff70afca5d8c27dccc",
        "name": "Jane Doe",
        "profilePicture": null,
        "type": "customer"
      }
    }
  ],
  "nextCursor": "<string>",
  "object": "list"
}

Query Parameters

limit - Number of responses to return (1-100, default 20)
cursor - Cursor from a previous response's nextCursor
responseId - Return a single response by ID
pageId - Only responses that answered this survey page
start / end - Only responses created inside this range (ISO 8601)

Response Format

Returns a list object. Each response has:

id - Response ID
user - The respondent (id, name, email, profilePicture, type), or null when anonymous or deleted
responses - One entry per answered page with pageId, type and value
createdAt - When the response was submitted

Rating answers are numbers. Multiple-choice answers are arrays of choice IDs that map to definition.content.pages[].choices of the survey.

Permissions

This endpoint returns recipient identity data. The API key owner needs both the manage_outbound and the view_users permission. MCP Writer connectors cannot call it; use a Reader or Combined connector.

Rate Limiting

Survey reads share a per-organization budget with audience preview and survey statistics. Exceeding it returns 429 with a Retry-After header.

Errors

400 - Invalid message ID or cursor
403 - Missing the view_users permission
404 - Survey not found, or the message is not a survey
429 - Organization read budget exceeded

Version Availability

This endpoint is only available in API version 2026-09-03.pulsar and newer.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

outboundMessageIdstringrequired

Outbound message ID

Example: 6457e3ff70afca5d8c27dccc

Query Parameters

responseIdstringquery

pageIdstringquery

Required string length: 1 - 100

cursorstringquery

limitintegerquerydefault:20

Required range: 1 <= x <= 100

startstring | nullquery

endstring | nullquery

Headers

Featurebase-Versionenum<string>header

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

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-09-03.pulsar

Response

Success

dataobject[]required

Survey responses, newest first

Show child attributes

nextCursorstring | nullrequired

Cursor for the next page, or null when there are no more results

Maximum string length: 512

objectenum<string>required

Object type identifier

Available options: list

Example: list

Still need help? Ask the team