Ir al contenido

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ámetroDescripción
cursorDónde comienza la página. Pase el campo cursor de la respuesta anterior. Omítalo en la primera llamada.
limitTamaño de la página. El rango permitido y el valor predeterminado se indican en cada endpoint, por ejemplo en List items.

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
}
CampoDescripción
countNúmero de resultados en esta página
limitTamaño de página usado en esta página
cursorPáselo como parámetro de consulta cursor para obtener la página siguiente. null cuando no hay más páginas.
has_moretrue si hay más resultados después de esta página
  1. Llame al endpoint de lista sin cursor.
  2. Mientras has_more sea true, vuelva a llamarlo con cursor igual al cursor de la última respuesta.
  3. Deténgase cuando has_more sea false.
Terminal window
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).