---
title: "Load a product screen through one authorized database transaction."
method: GET
path: "/v1/workspaces/{workspaceId}/surface-data/{surface}"
---

# Load a product screen through one authorized database transaction.

`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

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.

## Query parameters

- `limit` integer
- `webhook_id` string, uuid
- `event_type` string
- `receipt_before` string
- `mailbox_id` string, uuid
- `approval_id` string, uuid
- `label_id` string, uuid
- `view` 'inbox' | 'sent' | 'drafts' | 'archive' | 'trash' | 'spam' | 'all'
- `since` string, date-time

## Response `200`

Product-scoped first-paint screen data.

- object
  - `data` object, 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).

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)