Notify API reference

Notify API · Channels

get/v1/workspaces/{workspace_id}/channelsAuth

List channels

Whether each channel (inbox, email, push, web push) can deliver now, and the metadata of its credentials. Never returns a secret: credentials show a fingerprint only.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200 Every channel.

data*array

Every channel, in a fixed order: inbox, email, push, webpush.

Example

Request

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

Response

{
  "data": [
    {
      "channel": {},
      "configured": false,
      "status": {},
      "credentials": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "provider": {},
          "app_id": "string",
          "environment": {},
          "origin": {},
          "fingerprint": "string",
          "status": {},
          "public_key": "string",
          "key_id": "string",
          "team_id": "string",
          "client_email": "user@example.com",
          "last_verified_at": "2026-01-01T00:00:00.000Z",
          "last_error_code": "string",
          "created_at": "2026-01-01T00:00:00.000Z",
          "superseded_at": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ]
}