Saltar al contenido principal
GET
Exportar registros del objeto
Scopes requeridos: data_objects.export

Autorizaciones

Authorization
string
header
requerido

Usa Authorization: Bearer rk_live_....

Parámetros de ruta

object_id
string
requerido

Id del objeto, clave de sistema como system:leads, o slug del descubrimiento.

Required string length: 1 - 200

Parámetros de consulta

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
view_id
string
Maximum string length: 200
filters_json
string

Texto JSON de un ObjectFilterQuery. Envía un array de filtros que deben coincidir todos, o un objeto con filters y un filtro avanzado cuyas reglas se unen con and u or. Cada filtro indica un campo en fieldId por su id o su clave, tal como los lista GET /api/v1/objects/{object_id}. Operadores: is_empty e is_not_empty no reciben value. equals, not_equals, contains y has_reached reciben value. any_of recibe un array de cadenas. greater_than y less_than reciben un número, y between recibe value y valueTo. before y after reciben una fecha (YYYY-MM-DD) o una fecha/hora ISO 8601 y excluyen el día que indican. within_range recibe value y valueTo e incluye ambos días. Una fecha sola cubre todo el día UTC. Una fecha/hora con desfase se convierte a UTC. Sin filters_json, la lectura aplica los filtros de view_id, o ninguno. Un JSON inválido, un operador desconocido, un value faltante, un campo desconocido o un campo que no se puede filtrar devuelve 400 con la ruta de cada problema. Ejemplo, registros creados en octubre de 2026: [{"fieldId":"created_at","operator":"within_range","value":"2026-10-01","valueTo":"2026-10-31"}]

Maximum string length: 20000
sorts_json
string

Texto JSON de un array de ObjectSort. Cada orden indica un campo en fieldId por su id o su clave. Sin sorts_json, la lectura usa el orden de view_id, o created_at, del más reciente al más antiguo. Solo un único orden por created_at o updated_at conserva el cursor keyset. Cualquier otro orden pagina por número. Un JSON inválido, un campo desconocido o un campo de fórmula devuelve 400. Ejemplo, registros más antiguos primero: [{"fieldId":"created_at","direction":"asc"}]

Maximum string length: 20000

Respuesta

Payload de exportación CSV.

filename
string
requerido
csv
string
requerido
record_count
integer
requerido
is_capped
boolean
requerido
next_cursor
string | null
requerido

Cursor para la siguiente respuesta de exportación, o null en la última.

has_more
boolean
requerido

true mientras siguen más registros. Vuelve a solicitar con next_cursor.

total
integer

Cantidad exacta de registros que coinciden con la exportación. Algunas exportaciones la incluyen y otras no, así que trátala como opcional.

Rango requerido: x >= 0