Notify API reference

Notify API · Export

get/v1/workspaces/{workspace_id}/exportAuth

Export the configuration

Categories, notification types with every template, and settings, in the shapes the create and `PUT /notification-types/by-key/{key}` calls accept: apply it to another workspace to promote a setup. Recipients are exported with `GET /recipients?include=preferences`.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200 The configuration.

categories*array

Every category.

notification_types*array

Every notification type with its templates.

settings*object

Workspace settings (defaults written by the settings API).

exported_at*string · date-time

When the export was made.

Example

Request

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

Response

{
  "categories": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "key": "security",
      "name": "string",
      "description": "string",
      "defaults": {},
      "ordinal": 0,
      "android_channel_id": "string",
      "transactional": false,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "notification_types": [
    {
      "key": "string",
      "name": "string",
      "description": "string",
      "category_key": "string",
      "routing": {},
      "critical": false,
      "ttl_seconds": 0,
      "default_locale": "string",
      "email_quiet_hours": false,
      "throttle": {},
      "archived_at": "2026-01-01T00:00:00.000Z",
      "templates": [
        {
          "channel": "inbox",
          "locale": "string",
          "body": {}
        }
      ]
    }
  ],
  "settings": {},
  "exported_at": "2026-01-01T00:00:00.000Z"
}