Notify API reference

Notify API · Settings

get/v1/workspaces/{workspace_id}/settingsAuth

Get Notify settings

Email on/off and, after an automatic pause, when and why email was paused; the default time zone and quiet hours for recipients without their own.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200 The settings.

email_enabled*boolean

Whether Notify sends email for this workspace. Off: every email delivery is skipped as `channel_not_configured`.

email_paused_at*string · date-time

Set when Notify paused email automatically: more than 0.1 % complaints or 5 % hard bounces among the last 500 email deliveries (counted once at least 100 exist). While set, email deliveries are skipped as `email_paused`, critical types included. Clear it with `PATCH` `{ "email_paused": false }`.

email_paused_reason*string

Why email was paused, e.g. "2 complaints in the last 140 emails".

email_resumed_at*string · date-time

When email was last resumed after a pause. The pause check only counts emails sent after it.

default_timezone*string

IANA time zone for recipients who have none on their profile (and no time zone on the device, for push). Null: recipients without a time zone are never held for quiet hours.

Example: "Europe/Lisbon"

default_quiet_hours*object

Quiet hours for recipients who set none of their own. Push and web push wait until the window ends (plus up to 10 minutes, so a morning backlog spreads out); email waits only for types with `email_quiet_hours`; the inbox and critical types never wait. A hold past the type TTL fails as `expired`.

client_origins*array

Browser origins allowed to call the client API (`/v1/client/…`) with a recipient token. Empty: only `http://localhost` (any port) is accepted, for development. Calls without an `Origin` header (native apps) are not origin-checked.

Example: ["https://app.example.com"]

Example

Request

GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/settings
Authorization: Bearer YOUR_TOKEN

Response

{
  "email_enabled": false,
  "email_paused_at": "2026-01-01T00:00:00.000Z",
  "email_paused_reason": "string",
  "email_resumed_at": "2026-01-01T00:00:00.000Z",
  "default_timezone": "Europe/Lisbon",
  "default_quiet_hours": {},
  "client_origins": [
    "https://app.example.com"
  ]
}