Brief delivery API Reference

GET

Read workspace Brief defaults

GET /external/v1/brief-delivery

Read the workspace defaults, revision, email availability and active human member counts. defaults is null until an admin saves a policy; otherwise it contains enabled, productIds, cadence, dayOfWeek, timeOfDay, timezone, emailTitles and firstEdition (now or scheduled). Counts separate unconfigured members, members using workspace defaults, and personal settings. This read does not apply defaults or change preferences.

Requirements

API scopes required:

brief:read

Responses

200

Success

Saved configuration or operational metadata. No email is generated or sent.

403

Access required

Requires brief:read and the key creator’s current active owner/admin membership. Keys without a creator are refused.

Example Request

GET

/external/v1/brief-delivery

curl

curl 'https://zentrik.ai/api/external/v1/brief-delivery' -H 'Authorization: Bearer YOUR_API_KEY'

Example Response

200 OK

json

{
  "defaults": null,
  "revision": 0,
  "deliveryAvailable": true,
  "counts": {
    "members": 2,
    "unconfigured": 1,
    "managed": 0,
    "personal": 1
  }
}

GET

Read member delivery status

GET /external/v1/brief-delivery/members

Find active human members by name or email. The body contains items and pagination, ordered by email then user ID. Each item includes identity, preferenceSource (unconfigured, workspace or member; null when no subscription exists), followed Product IDs/names, followsAllProducts, scopeCount, enabled, emailTitles, schedule, nextRunAt, generation blockers and latest non-test delivery metadata. Private filter text, email bodies and unsubscribe tokens are excluded. status distinguishes not_configured, defaults_pending, email_off, workspace_paused, email_suppressed, scope_missing, generation_blocked, confirming_send, send_failed, due, overdue, queued, scheduled and not_scheduled. A scheduled check may not produce email. acceptedAt records provider acceptance, not inbox delivery or reading. Future content is unknown until an edition is generated; editionId does not grant access to another member’s email.