Is Paused
/leads/{id}/is_paused
Returns whether a lead's automation is currently paused due to human takeover. A lead is considered paused if any of its active (non-terminal) workflow runs has human_takeover = true.
Use this to quickly check pause state without having to fetch and inspect a full workflow run.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Lead ID |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workflow_id | string (uuid) | No | Restrict the pause check to a specific workflow run for this lead. |
Example
curl https://api.getnexor.ai/api/public/leads/lead-uuid/is_paused \
-H "X-API-Key: nxr_live_your_api_key"
Scoped to a specific workflow:
curl "https://api.getnexor.ai/api/public/leads/lead-uuid/is_paused?workflow_id=workflow-uuid" \
-H "X-API-Key: nxr_live_your_api_key"
Responses
200 — Pause state retrieved
{
"success": true,
"paused": false
}
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Always true on success |
paused | boolean | true if the lead has at least one active workflow run with human_takeover = true |
401 — Authentication error
See Authentication.
404 — Lead not found
{
"error": "Not found",
"message": "Lead not found or does not belong to your account"
}