Paginación
Recorra listas largas en la API de BoxHero con paginación basada en cursor.
Los endpoints de listas devuelven los resultados página por página y usan paginación basada en cursor.
Parámetros de consulta
Sección titulada «Parámetros de consulta»| Parámetro | Descripción |
|---|---|
cursor | Dónde comienza la página. Pase el campo cursor de la respuesta anterior. Omítalo en la primera llamada. |
limit | Tamaño de la página. El rango permitido y el valor predeterminado se indican en cada endpoint, por ejemplo en List items. |
Respuesta
Sección titulada «Respuesta»Cada página incluye los resultados junto con los campos necesarios para obtener la siguiente:
{ "items": [...], "count": 100, "limit": 100, "cursor": 1234567, "has_more": true}| Campo | Descripción |
|---|---|
count | Número de resultados en esta página |
limit | Tamaño de página usado en esta página |
cursor | Páselo como parámetro de consulta cursor para obtener la página siguiente. null cuando no hay más páginas. |
has_more | true si hay más resultados después de esta página |
Obtener todas las páginas
Sección titulada «Obtener todas las páginas»- Llame al endpoint de lista sin
cursor. - Mientras
has_moreseatrue, vuelva a llamarlo concursorigual alcursorde la última respuesta. - Deténgase cuando
has_moreseafalse.
curl "https://rest.boxhero-app.com/v1/items?cursor=1234567" \ -H "Authorization: Bearer $BOXHERO_API_TOKEN"Mantenga en todas las llamadas siguientes los mismos filtros que usó en la primera.
Cada recurso define su propio orden. La mayoría de los endpoints de listas devuelven los resultados por id, en orden ascendente. List transactions devuelve primero las transacciones más recientes (por hora de la transacción, con el id como criterio de desempate).