> ## Documentation Index > Fetch the complete documentation index at: https://docurise.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # List email broadcasts > List your email broadcasts with status, schedule and frozen recipient count (metadata only) ## OpenAPI ````yaml api-reference/openapi.yaml GET /api/preview/email/broadcasts openapi: 3.1.0 info: title: DocuRise Public API version: preview description: > Programmatic access to DocuRise. **This is a preview API.** Every path is versioned under `/api/preview/` and carries no compatibility guarantee while it is in preview: fields, values and error codes may be added, changed or removed. Once the contract stabilizes it will be promoted to `/api/v1/`. See the [changelog](/changelog) for what changed and when. ### Access Every route requires: 1. A valid API key (see Authentication below). 2. The calling account's plan must be **Iconic or above**. 3. During the preview the API is available to some accounts only, whatever the plan. Accounts without access get a `404` from every route below; if you expect access, check with your DocuRise contact. Generate and manage keys from **Settings → Developers** in the dashboard. ### Idempotency `POST` endpoints that create a resource require an `Idempotency-Key` header. Reusing the same key with the same request body replays the original response (same status code, same body) instead of creating a second resource — safe to retry on timeout or connection loss. A key is remembered for 7 days; after that the same key is treated as a new request. Reusing the same key with a **different** body is rejected with `IDEMPOTENCY_KEY_CONFLICT`. Generate a fresh key (a UUID or ULID is fine) per logical operation, not per HTTP attempt. One exception: `POST /api/preview/tags` takes no `Idempotency-Key`. Creating the same tag name twice changes nothing (the second call returns the existing tag with `created: false`), so a retry is always safe. Another exception: `POST /api/preview/segments/preview` takes no `Idempotency-Key`. It saves nothing, so repeating it is always safe. ### Response compatibility Responses may gain additional fields over time, and `type`/`code`-style enum values (for example a future `LeadFormQuestion.type` member, or a new error `code`) may gain new members. Always ignore fields and enum values you don't recognize rather than treating them as errors — this is what makes every additive change under `preview` non-breaking. A field absent from a response is not always the same as a field present with value `null`. A field whose type never includes `null` is omitted when it doesn't apply — it is never sent as `null` (for example, `retryAfterSeconds` is left out entirely when there's no backoff hint, not set to `null`). A field whose type explicitly allows `null` uses it to mean something real and distinct from "not present" (for example, `expiresAt: null` on a document means it has no fixed expiry date, not "unknown" or "not applicable"). All field names use `camelCase` — `notionUrl`, `leadFormQuestions`, `collectName`, and so on — consistently across every request and response body. ### Identifiers `id` values are opaque strings. Store and compare them as unstructured tokens — don't parse them, validate their format, or assume anything about their length or character set. ### Errors Every error response has the same shape: ```json { "error": { "code": "STRING", "message": "human-readable", "retryable": false } } ``` Switch on `code`, not `message` — `message` is free text for logs/debugging and may be reworded without notice; `code` is the stable contract. `retryable` tells you whether the same request is safe to retry as-is; when present, `retryAfterSeconds` is a concrete backoff hint. A request body that contains a NUL character (`\u0000`), in a string value or in a property name, is refused with `400 VALIDATION_ERROR` before anything is saved. ### Rate limiting 60 requests/minute per account across all `/api/preview/*` routes, regardless of how many keys that account has. Exceeding it returns `429` with a `Retry-After` header. Separately, an account can have at most 10 requests running at the same moment across these routes, however many keys it has. A request that would be the eleventh returns `429` with `code: TOO_MANY_CONCURRENT_REQUESTS` and `Retry-After: 1`; wait for one of your requests to finish and retry. This limit counts requests that have not finished, so it can apply even while you are under 60 requests per minute. contact: name: DocuRise url: https://docurise.io servers: - url: https://docurise.io description: Production security: - apiKey: [] tags: - name: Documents description: >- Create documents (a Notion page, a post or a lead-capture form), list or read the documents you own, publish drafts, and change their status, expiry and email protection. - name: Analytics description: >- Read aggregate view, visitor, lead and conversion numbers for one of your documents, split by traffic channel, compared with the previous period, or as a form funnel, and rank all of your documents by views, visitors or leads. - name: Folders description: Read your folders and courses, with item counts. - name: Products description: Read your product catalog (read-only). - name: Audiences description: >- List your tags and groups with contact counts, create a group from a rule, count who a rule would match, and read one group with its rule. Counts only; no member data is ever returned. - name: Contacts description: >- Add or remove a tag on one of your contacts. Contact details are never returned. - name: Email description: >- Read email broadcasts, their aggregate delivery numbers, and automations. Email only; Kakao is not included. - name: Instagram description: >- Create, read, edit, pause and resume Instagram comment-to-DM automation rules. - name: Account description: Inspect the API key you are calling with. paths: /api/preview/email/broadcasts: get: tags: - Email summary: List email broadcasts description: | Lists your email broadcasts, newest first (by creation time), as metadata only. The message body, preview text, audience filter and recipients are never returned. Requires the `email:read` scope. Email only: Kakao broadcasts are not included. `recipientCount` is the audience size frozen when the broadcast was sent, so it is stable and cheap. It is `null` whenever `sentAt` is `null`, whatever the status: a `draft` or `scheduled` broadcast, one still `sending`, or a `failed` one where nothing went out (`sentAt` is only set once at least one message was sent). `status` is one of `draft`, `scheduled`, `sending`, `sent`, `partial` (some recipients failed) or `failed`. `q` matches the name or subject, case-insensitively. `sentAfter` (inclusive) and `sentBefore` (exclusive) filter on the send time, so unsent broadcasts are excluded when either is given. Both are RFC 3339 datetimes with `Z` or a numeric UTC offset. Page with `nextCursor`: pass it back as `cursor` until it is `null`. Unknown or repeated query parameters are rejected with `VALIDATION_ERROR`. operationId: listEmailBroadcasts parameters: - name: q in: query required: false description: >- Only broadcasts whose name or subject contains this text (1 to 100 characters). Matched as plain text, so `%` and `_` are not wildcards. Must not contain a NUL character (`%00`); one is rejected with `VALIDATION_ERROR`. schema: type: string minLength: 1 maxLength: 100 - name: status in: query required: false description: >- Only broadcasts with this status. `paused` is not accepted, though a paused broadcast can appear in the list. schema: type: string enum: - draft - scheduled - sending - sent - partial - failed - name: sentAfter in: query required: false description: >- Only broadcasts sent at or after this instant (RFC 3339, e.g. `2026-10-01T00:00:00Z`). schema: type: string format: date-time - name: sentBefore in: query required: false description: >- Only broadcasts sent before this instant (RFC 3339). Must not be earlier than `sentAfter`, and the range may not exceed 366 days. schema: type: string format: date-time - name: limit in: query required: false description: Broadcasts per page. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: cursor in: query required: false description: The `nextCursor` from the previous page. schema: type: string maxLength: 512 responses: '200': description: A page of broadcasts. content: application/json: schema: $ref: '#/components/schemas/ListEmailBroadcastsResponse' '400': description: >- `VALIDATION_ERROR` (a bad, repeated or unknown query parameter, or an invalid date range; `message` names it) or `INVALID_CURSOR` (not a cursor this API issued). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- `PLAN_REQUIRED`, `PAST_DUE_RESTRICTED` or `INSUFFICIENT_SCOPE` (the key lacks `email:read`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': $ref: '#/components/responses/NotOnAllowlist' '429': $ref: '#/components/responses/RateLimited' '500': description: '`INTERNAL_ERROR` (retryable). The cause is not echoed.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/Unavailable' security: - apiKey: [] x-codeSamples: - lang: bash label: curl source: > curl "https://docurise.io/api/preview/email/broadcasts?status=sent&limit=20" \ -H "Authorization: Bearer $DOCURISE_API_KEY" components: schemas: ListEmailBroadcastsResponse: type: object required: - data - nextCursor properties: data: type: array items: $ref: '#/components/schemas/EmailBroadcast' description: The broadcasts on this page. nextCursor: type: - string - 'null' description: Pass as `cursor` to get the next page. `null` on the last page. example: data: - id: 7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90 name: October launch subject: We just shipped status: sent scheduledAt: null sentAt: '2026-10-01T09:00:12.000Z' recipientCount: 1280 - id: 0b9a3c1d-5e7f-4a21-8c3d-9e1f2a3b4c5d name: null subject: Next week status: draft scheduledAt: null sentAt: null recipientCount: null nextCursor: null ErrorResponse: type: object required: - error properties: error: type: object required: - code - message - retryable properties: code: type: string description: >- Stable machine-readable error code — switch on this, not `message`. message: type: string description: Human-readable detail. May change wording without notice. retryable: type: boolean description: Whether retrying the identical request may succeed. retryAfterSeconds: type: integer description: Present only when a concrete backoff hint applies. details: type: object description: > Present only for a few specific codes: - `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`). Open-ended: tolerate new values. - `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule. - `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`, `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`, `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`, `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`. - `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`. Open-ended: tolerate new values. - `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not accepted and where it sits in the request. For a condition shape refused where it sits also `operator: string` and, when there is an equivalent operator for `requiredConditions`, `invertTo: string`. - `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or `step`. Open-ended: tolerate new values. - `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist. - `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account. - `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API. description: >- The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`. EmailBroadcast: type: object required: - id - name - subject - status - scheduledAt - sentAt - recipientCount description: >- An email broadcast's metadata. Never includes the body, audience filter or recipients. properties: id: type: string format: uuid description: Opaque broadcast identifier. name: type: - string - 'null' description: The display name, or `null` if none. subject: type: string description: The subject line. status: type: string enum: - draft - scheduled - sending - paused - sent - partial - failed description: >- `draft` (not scheduled or sent), `scheduled` (waiting for `scheduledAt`), `sending` (going out now), `paused` (held, with a reason, and resumes or can be cancelled), `sent` (sent to every recipient it could), `partial` (sent, but some recipients got nothing because of delivery failures or because they were held back) or `failed` (nothing was sent, or the send was cancelled or blocked, for example by the plan). scheduledAt: type: - string - 'null' format: date-time description: When the broadcast is or was scheduled to go out, or `null`. sentAt: type: - string - 'null' format: date-time description: >- When the send went out (set once at least one message was sent), or `null` otherwise. recipientCount: type: - integer - 'null' description: >- The audience size frozen at send time. `null` whenever `sentAt` is `null` (draft, scheduled, sending, or failed without any send). responses: Unauthorized: description: 'Missing, malformed, or revoked API key (`code: UNAUTHORIZED`).' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotOnAllowlist: description: | The API is available to some accounts only, whatever the plan. If you expect access, check with your DocuRise contact (`code: NOT_FOUND`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' RateLimited: description: >- Rate limited (`code: RATE_LIMITED`, always retryable): see the `Retry-After` header and `X-RateLimit-*` headers. Or too many requests running at once (`code: TOO_MANY_CONCURRENT_REQUESTS`, always retryable): `Retry-After` is `1` and there are no `X-RateLimit-*` headers. headers: Retry-After: schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer description: Unix timestamp (seconds) when the limit resets. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unavailable: description: | A server-side dependency is temporarily down (`RATE_LIMIT_UNAVAILABLE` or `SERVICE_UNAVAILABLE`). Not a problem with the request or key; always retryable — honor `retryAfterSeconds` when present. The group endpoints (`POST /segments`, `POST /segments/preview`, `GET /segments/{id}`) also return it when a very heavy rule could not be counted within about 10 seconds: simplify the rule or retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: apiKey: type: http scheme: bearer bearerFormat: dr_live__ description: | A key generated from Settings → Developers, sent as `Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>`. Keys carry explicit scopes — each endpoint states the one it requires. The full key is shown exactly once at generation time and cannot be retrieved again; only the `keyId` prefix is shown afterward. A revoked key fails auth on its very next request. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.