Skip to main content
Outbound

List users in the Outbound analytics feed

Returns the recipient event feed of a message: who received, opened, clicked or answered it and when.

GET
/v2/outbound/messages/{outboundMessageId}/analytics/users

Query Parameters

  • start - Range start (ISO 8601, required)
  • end - Range end (ISO 8601, required, exclusive)
  • metrics - Comma-separated metrics to include (defaults to every metric of the message type)
  • limit - Number of events to return (1-100, default 25)
  • cursor - Cursor from a previous response's nextCursor

Response Format

Returns a list object with one row per event, newest first. Each row has the user's id, name, email, profilePicture and type, plus event, eventAt, eventId and deliveryId. Users that were deleted appear without identity fields.

Use deliveryId with the delivery events endpoint to trace one delivery, or id with the user deliveries endpoint to trace one recipient.

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.

Errors

  • 400 - Invalid message ID, range, cursor or metrics filter
  • 403 - Missing the view_users permission
  • 404 - Message not found or doesn't belong to your organization
  • 502 / 504 - The analytics store failed or timed out

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

metricsstringquery
Maximum string length: 500
startstring | nullquery
endstring | nullquery
limitintegerquerydefault:25
Required range: 1 <= x <= 100
cursorstringquery
Maximum string length: 500

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

application/json

Success

dataobject[]required

Recipient events, newest first

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