Skip to main content
GET
List leads

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Parámetros de consulta

page
integer
predeterminado:0

Zero-based page index.

Rango requerido: x >= 0
limit
integer
predeterminado:25
Rango requerido: 1 <= x <= 100

Case-insensitive, word-by-word search. Every space-delimited word must match at least one of the lead's first name, last name, email, phone, or company.

workflow_id
string<uuid>
assigned_to
string<uuid>

Only leads currently owned by this team member. Cannot be combined with unassigned_only=true.

unassigned_only
boolean
predeterminado:false

Only leads with no current human owner.

updated_since
string<date-time>

Only leads updated at or after this timestamp.

history_since
string<date-time>

Only leads whose timeline gained an event (message, call, email, status change, meeting, conversion, Instagram/Messenger DM) at or after this timestamp. Compares against last_history_at; the comparison is inclusive, so pass the exact last_history_at value you last saw as the cursor. Leads with last_history_at null are never returned by this filter.

sort_by
enum<string>
predeterminado:created_at
Opciones disponibles:
created_at,
updated_at,
last_contacted_at,
last_history_at,
name,
source
sort_dir
enum<string>
predeterminado:desc
Opciones disponibles:
asc,
desc
run_state
enum<string>

Select active runs or all runs. Defaults to active, except workflow_id defaults it to all.

Opciones disponibles:
active,
all
status_id
string

Filter by status ID.

verbose
enum<string>

Use full instead of the slim projection.

Opciones disponibles:
full

Respuesta

Lead page

success
boolean
requerido
leads
object[]
requerido
pagination
object
requerido
Última modificación el 8 de septiembre de 2026