Load a product screen through one authorized database transaction.

Returns the bounded first-paint data for one product-scoped screen. The request validates workspace membership and the selected product in the same tenant-isolated transaction as the endpoint queries. The webhooks screen includes event_definitions (Journey trigger and goal names, including drafts), event_stats (counts across saved incoming receipts), and receipts (newest first, up to 51 rows). Clients display 50 receipts and use the extra row to detect another page. Incoming webhooks include a public_url; credentials are fetched separately. Receipt metadata does not contain raw payloads or a historical test/live label. outgoing_event_types contains the fixed catalog of automatic Banger events and the manual webhook.test event, independent of configured endpoints.

get/v1/workspaces/{workspaceId}/surface-data/{surface}

Request

  • Base URL: https://api.bangermail.com
  • URL: https://api.bangermail.com/v1/workspaces/{workspaceId}/surface-data/{surface}
  • Auth: HTTP bearer

Query parameters

limitinteger
webhook_idstring uuid

On the webhooks screen, restrict receipt history and outbound deliveries to this endpoint.

event_typestring

On the webhooks screen, filter incoming receipts by exact event name. Catalog definitions and totals remain product-wide.

receipt_beforestring

Incoming receipt cursor, a JSON object with receivedAt, endpointId, and eventId from the last displayed row. Preserve receivedAt verbatim to retain sub-millisecond precision. URL-encode the JSON value.

mailbox_idstring uuid
approval_idstring uuid
label_idstring uuid
view'inbox' | 'sent' | 'drafts' | 'archive' | 'trash' | 'spam' | 'all'
sincestring date-time

Response

Product-scoped first-paint screen data.

dataobject required

Screen-specific aggregate selected by surface and query parameters. Keys and nested resource projections vary by surface (home, product, broadcasts, audience, domains, mailboxes, journeys, deliverability, api_keys, webhooks, approvals, connections, logs).

Changes

No recorded changes to this operation across all 1 revision of this API.