Skip to main content
GET
Check if lead automation is paused

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Lead ID

Query Parameters

workflow_id
string<uuid>

Optional. Restrict the pause check to a specific workflow run for this lead.

Response

Pause state retrieved successfully

success
boolean
required
paused
boolean
required

True if automation is paused (human takeover active)

Last modified on July 10, 2026