Notify API reference

Notify API · Approvals

get/v1/workspaces/{workspace_id}/approvals/{approval_id}Auth

Get an approval request

Its status, the answer (who, when, why, from where) and its trail. With `wait_seconds` (up to 15) a pending request is long-polled: the call returns as soon as someone answers, or after that many seconds.

Path parameters

workspace_id*string · uuid

Id of the workspace.

approval_id*string · uuid

The approval request id.

Query parameters

wait_secondsinteger

While `pending`, wait up to this many seconds for an answer before responding (long poll).

Response · 200 The request.

id*string · uuid

The approval request id.

type*string

The notification type key.

Example: "deploy.approval"

status*object

`pending` until someone answers; then `approved` or `rejected`; `expired` (or the type's timeout outcome) when nobody answered in time; `cancelled` when the requester withdrew it.

title*string

The question.

body*string

The details.

requester*object

Who asked.

approvers*array

Approver external ids (null entries for erased recipients are dropped).

metadata*object

Your metadata, as sent.

expires_at*string · date-time

When it times out.

decided_by*string

Who answered (external id); null while pending, on timeout or cancel.

reason*string

The approver's reason, if they gave one.

decided_via*object

Where the answer came from: `inbox` (in-app buttons or `<NotifyApproval/>`), `hosted_page` (the link in an email or push), `api` (your backend), `timeout`.

decided_at*string · date-time

When it was answered, expired or cancelled.

notification_id*string · uuid

The notification that carried it (see the message log for every channel's delivery).

created_at*string · date-time

Created.

events*array

The request's trail, oldest first: who asked, who was notified, every answer (refused ones too), the webhook.

Example

Request

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "deploy.approval",
  "status": {},
  "title": "string",
  "body": "string",
  "requester": {},
  "approvers": [
    "string"
  ],
  "metadata": {},
  "expires_at": "2026-01-01T00:00:00.000Z",
  "decided_by": "string",
  "reason": "string",
  "decided_via": {},
  "decided_at": "2026-01-01T00:00:00.000Z",
  "notification_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "events": [
    {
      "kind": "decided",
      "actor": "string",
      "detail": {},
      "at": "2026-01-01T00:00:00.000Z"
    }
  ]
}