Outbound

Search Outbound messages and Updates

Searches the unified Outbound list that the dashboard shows: chats, banners, emails, surveys and Updates in one timeline.

POST

/v2/outbound/messages/search

curl --request POST \
  --url https://do.featurebase.app/v2/outbound/messages/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "filter": {
    "field": "state",
    "operator": "=",
    "value": "<string>"
  },
  "limit": 25,
  "sort": [
    {
      "direction": "asc",
      "field": "name"
    }
  ]
}
'

{
  "data": [
    {
      "audienceTypes": [
        "users"
      ],
      "conversationTagIds": [],
      "createdAt": "2026-09-01T09:30:00.000Z",
      "createdBy": {
        "id": "6438a1efda3640f8feb72121",
        "name": "Jane Doe",
        "profilePicture": null
      },
      "deliveryStats": {
        "opened": 75,
        "sent": 120
      },
      "firstActivatedAt": "2026-09-03T12:00:00.000Z",
      "id": "6457e3ff70afca5d8c27dccc",
      "lastActivatedAt": "2026-09-03T12:00:00.000Z",
      "matchBehavior": "dynamic",
      "name": "Onboarding welcome chat",
      "object": "outbound_message",
      "sender": {
        "id": "6438a1efda3640f8feb72121",
        "name": "Jane Doe",
        "profilePicture": null
      },
      "state": "draft",
      "stats": {
        "opened": 80,
        "sent": 120
      },
      "subscriptionTopicId": null,
      "type": "chat",
      "updatedAt": "2026-09-03T12:00:00.000Z",
      "updatedBy": {
        "id": "6438a1efda3640f8feb72121",
        "name": "Jane Doe",
        "profilePicture": null
      }
    }
  ],
  "hasMore": true,
  "limit": 25,
  "nextCursor": "<string>",
  "object": "list",
  "totalResults": 42
}

Request Body

filter - Optional filter AST. Supported fields include type, state, name, createdBy, conversationTagIds, changelogCategories, createdAt and updatedAt
sort - Optional single sort rule (defaults to newest first)
limit - Number of rows to return (1-100, default 25)
cursor - Cursor from a previous response's nextCursor

Type Filter

The type field accepts chat, banner, email, survey or changelog. Use changelog to select release notes.

Response Format

Returns a list object with:

object - Always "list"
data - Array of list rows. Each row has object: "outbound_message" or object: "changelog"
nextCursor - Cursor for the next page (null if no more results)
hasMore, limit, totalResults - Paging metadata

List rows do not include the full message definition. Use the get endpoints for the complete object.

Example

{
  "filter": {
    "operator": "AND",
    "value": [
      { "field": "type", "operator": "=", "value": "survey" },
      { "field": "state", "operator": "=", "value": "live" }
    ]
  },
  "limit": 25
}

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

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

Body

cursorstring

Cursor from the previous response

Maximum string length: 512

filterobject

Outbound filter AST. The type field accepts chat, banner, email, survey, or changelog. Changelogs appear as Updates in the dashboard.

Show child attributes

limitintegerdefault:25

Required range: 1 <= x <= 100

sortobject[]

Sort rules. One sort rule is supported.

Required array length: 0 - 1

Show child attributes

Response

Success

dataobject[]required

Array of Outbound list rows

Show child attributes

hasMorebooleanrequired

Whether another page exists

Example: true

limitnumberrequired

Page size that was applied

Example: 25

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

totalResultsnumberrequired

Total number of matching rows

Example: 42

Still need help? Ask the team