Paginación de la API (page, per_page y cursor)
Cómo paginar listados de la API de Omnifox con page/per_page o con paginación por cursor.
Los endpoints que devuelven listas (contactos, conversaciones, oportunidades, ítems de tablero, etc.) usan paginación para no traer miles de registros en una sola respuesta. Omnifox soporta dos estilos: paginación por página (por defecto) y paginación por cursor.
Paginación por página (por defecto)
Parámetros:
page: número de página, empieza en1.per_page: cantidad de ítems por página, máximo100(por defecto15).
La respuesta trae:
{
"success": true,
"data": [ ... ],
"meta": { "current_page": 1, "last_page": 5, "per_page": 15, "total": 73, "from": 1, "to": 15 },
"links": { "first": "...", "last": "...", "prev": null, "next": "..." }
}
Usá links.next directamente para avanzar sin recalcular la URL vos mismo.
Paginación por cursor
Agregá ?pagination=cursor al listado. La respuesta cambia de forma:
{
"items": [ ... ],
"pagination": {
"next_cursor": 12345,
"previous_cursor": 12380,
"has_more": true,
"limit": 20
}
}
Para pedir la siguiente página, pasá ?cursorId=12345 en la próxima llamada. Es el modo recomendado para listas que cambian constantemente (por ejemplo, mensajes de una conversación activa), porque no se "salta" ni repite registros cuando se insertan filas nuevas entre una página y otra.
Ejemplo: recorrer todos los contactos con cursor
curl "https://app.omnifox.io/api/v1/contacts?pagination=cursor&limit=50" \
-H "Authorization: Bearer TU_TOKEN"
# siguiente página:
curl "https://app.omnifox.io/api/v1/contacts?pagination=cursor&limit=50&cursorId=12345" \
-H "Authorization: Bearer TU_TOKEN"
Consejos
- Para exportaciones masivas (miles de registros), preferí cursor:
page/per_pageconLIMIT/OFFSETse vuelve lento en páginas muy altas. - Detené el recorrido cuando
has_moreseafalseonext_cursorseanull.
Solución de problemas
- Se repiten o faltan registros al paginar con
page: si el listado se ordena por un campo que cambia (comolast_message_at), la inserción de nuevas filas puede correr los resultados entre páginas; cambiá a cursor. per_pagemayor a 100 no tiene efecto: el máximo permitido es 100; valores mayores se recortan.
Artículos relacionados
-
Cómo conectar integraciones y apps externas
Conecta Omnifox con tus herramientas favoritas desde el catálogo de integraciones en pocos pasos.
-
Generar y usar API keys y webhooks
Crea claves de API para acceder a Omnifox por código y configura webhooks para recibir eventos en tiempo real.
-
Introducción a las integraciones (webhook / OAuth / API key)
Conecta Omnifox con tus otras herramientas. Aprende cuándo usar un webhook, una conexión OAuth de la galería o una clave de API.
-
La API REST de Omnifox: introducción y requisitos de plan
Qué es la API REST de Omnifox, qué plan necesitas (desde Crece), cómo autenticar con la cabecera X-API-Key y dónde está la documentación.
-
Crear una clave API personal (PAT)
Aprendé a generar tu primera clave API personal en Omnifox para conectar integraciones, scripts o herramientas externas a tu workspace.