Saltar al contenido principal
GET
Exportar leads
Scopes requeridos: leads.export

Autorizaciones

Authorization
string
header
requerido

Usa Authorization: Bearer rk_live_....

Parámetros de consulta

source
string
Maximum string length: 500
medium
string
Maximum string length: 500
campaign
string
Maximum string length: 500
conversion_type
enum<string>

Filtra leads por un tipo de conversión aprobado.

Opciones disponibles:
public_quiz,
onsite_form,
partner_api,
jobnimbus_import,
sms_inbound,
phone_call
communication_channel
enum<string>

Filtra leads que tienen al menos un evento de comunicación aprobado en el canal.

Opciones disponibles:
call,
sms
lead_type
string

Filtra leads por tipo de lead. Envíe la clave o la etiqueta actual de un tipo de lead del workspace. Un valor desconocido devuelve VALIDATION_ERROR.

Maximum string length: 100
from
string<date-time>

Límite inferior inclusivo de updated_at para sincronización incremental. Fecha/hora ISO 8601 con Z o un desfase ±HH:MM. Codifica + como %2B.

to
string<date-time>

Límite superior inclusivo de updated_at para sincronización incremental. Fecha/hora ISO 8601 con Z o un desfase ±HH:MM. Codifica + como %2B.

status_stage_id
string
Maximum string length: 150
Maximum string length: 200
cursor
string

Cursor opaco devuelto por respuestas de listado/exportación. Envíalo de vuelta sin cambios; los cursores malformados devuelven 400.

Maximum string length: 500
limit
integer
predeterminado:50

Tamaño de página de una lista de leads, de 1 a 100. Un valor mayor no devuelve 400; el servidor usa 100. La exportación ignora este valor y devuelve hasta 500 leads por respuesta. Una página puede contener menos leads que este valor, o ninguno, mientras has_more sea true. Siga solicitando con el cursor devuelto hasta que has_more sea false.

Rango requerido: x >= 1

Respuesta

Exportación CSV.

The response is of type string.