Skip to main content
GET
/
leads
/
{id}
/
is_paused
Check if lead automation is paused
curl --request GET \
  --url https://api.getnexor.ai/api/public/leads/{id}/is_paused \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.getnexor.ai/api/public/leads/{id}/is_paused"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.getnexor.ai/api/public/leads/{id}/is_paused', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getnexor.ai/api/public/leads/{id}/is_paused",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.getnexor.ai/api/public/leads/{id}/is_paused"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.getnexor.ai/api/public/leads/{id}/is_paused")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/leads/{id}/is_paused")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "paused": false,
  "ai_state": "off_locked"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "Not found",
"message": "Lead not found or does not belong to your account"
}
{
"error": "<string>",
"message": "<string>"
}

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

Legacy — human-takeover only. Can be false while ai_state is off_locked. Read ai_state instead.

ai_state
enum<string>
required

The real AI verdict. active = bot will act; paused_resumable = human takeover only (resume works); off_locked = off for a structural reason (resume is a no-op).

Available options:
active,
paused_resumable,
off_locked
Last modified on July 10, 2026