Paginación
Los endpoints de listado usan paginación por cursor. En la referencia de API, estos campos aparecen como parámetros opcionales de query en los endpoints de listado, por ejemplo GET /v1/customers, GET /v1/payment-intents/account, GET /v1/products y otros endpoints que devuelven colecciones.
En el explorador interactivo de la referencia API, los parámetros opcionales se muestran dentro de la sección Solicitud > Parámetros.
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
limit | number | Cantidad de objetos a retornar. Acepta valores entre 1 y 100. Si no se envía, la API usa 10. |
startingAfter | string | Cursor para pedir la página siguiente. Usá el id del último objeto recibido en la página actual. |
endingBefore | string | Cursor para pedir la página anterior. Usá el id del primer objeto recibido en la página actual. |
Enviá solo un cursor por solicitud. Si enviás startingAfter y endingBefore al mismo tiempo, la API responde con un error porque el backend solo puede navegar en una dirección por request.
Los nombres de los parámetros de entrada son startingAfter y endingBefore. En las respuestas de listado, la API devuelve esos cursores dentro de meta.cursorNext y meta.cursorBefore; usá meta.cursorNext como startingAfter para avanzar y meta.cursorBefore como endingBefore para volver.
Ejemplos
Primera página:
curl "https://api.onvopay.com/v1/customers?limit=10" \
-H "Authorization: Bearer onvo_test_secret_key_..."
Siguiente página:
curl "https://api.onvopay.com/v1/customers?limit=10&startingAfter=cl40muorw00493ndp0okzk2g3" \
-H "Authorization: Bearer onvo_test_secret_key_..."
Página anterior:
curl "https://api.onvopay.com/v1/customers?limit=10&endingBefore=cl40muorw00493ndp0okzk2g3" \
-H "Authorization: Bearer onvo_test_secret_key_..."
Cuando la respuesta incluye meta, podés usar los cursores de respuesta para construir la siguiente solicitud.
Recomendaciones
- Usá filtros para limitar el volumen de datos.
- Procesá páginas de forma incremental.
- No asumás que dos páginas consecutivas son inmutables si los datos cambian mientras recorrés la lista.