Skip to main content

​
Endpoint

GET /api/notify/status/{request_id}

​
Path parameters

​
request_id
string
required
The request_id returned from Send Notification or Interactive Notifications.

​
Headers

HeaderRequiredDescription
X-API-KeyYesYour API key (must belong to the same organization)

​
Response

​
status
string
Overall request status:
  • "pending" — Waiting for responses or timeout
  • "finished" — All users responded or timeout reached
​
external_reference_id
string
Your correlation ID, if provided in the original request.
​
responses
array
One entry per recipient:
FieldTypeDescription
user_emailstringRecipient email
option_valuestring | nullThe value of the chosen option, or null if not yet responded
timestampstring | nullISO 8601 timestamp of the response
expiredbooleanWhether this user’s response window expired

​
Example

curl https://app.nextks.com/api/notify/status/req_a1b2c3d4e5f6 \
  -H "X-API-Key: nks_abc123..."

​
Pending response

{
  "status": "pending",
  "external_reference_id": "deploy-v2.4.1",
  "responses": [
    {
      "user_email": "[email protected]",
      "option_value": "approve",
      "timestamp": "2026-02-11T14:23:01.000Z",
      "expired": false
    },
    {
      "user_email": "[email protected]",
      "option_value": null,
      "timestamp": null,
      "expired": false
    }
  ]
}

​
Finished response

{
  "status": "finished",
  "external_reference_id": "deploy-v2.4.1",
  "responses": [
    {
      "user_email": "[email protected]",
      "option_value": "approve",
      "timestamp": "2026-02-11T14:23:01.000Z",
      "expired": false
    },
    {
      "user_email": "[email protected]",
      "option_value": null,
      "timestamp": null,
      "expired": true
    }
  ]
}

​
Errors

StatusDetails
400Invalid request_id format
401Invalid API key
404Request not found or belongs to a different organization