Pagination

Parcourez de longues listes dans l’API BoxHero grâce à la pagination par curseur.

Les endpoints de liste renvoient les résultats page par page et utilisent une pagination par curseur.

Paramètres de requête

Paramètre	Description
`cursor`	Point de départ de la page. Transmettez le champ `cursor` de la réponse précédente. Omettez-le lors du premier appel.
`limit`	Taille de la page. La plage autorisée et la valeur par défaut sont indiquées pour chaque endpoint, par exemple List items.

Réponse

Chaque page contient les résultats ainsi que les champs nécessaires pour récupérer la suivante :

{
  "items": [...],
  "count": 100,
  "limit": 100,
  "cursor": 1234567,
  "has_more": true
}

Champ	Description
`count`	Nombre de résultats sur cette page
`limit`	Taille de page utilisée pour cette page
`cursor`	Transmettez cette valeur comme paramètre de requête `cursor` pour obtenir la page suivante. `null` lorsqu’il n’y a plus de pages.
`has_more`	`true` s’il reste des résultats après cette page

Récupérer toutes les pages

Appelez l’endpoint de liste sans cursor.
Tant que has_more vaut true, appelez-le de nouveau avec cursor défini sur le cursor de la dernière réponse.
Arrêtez-vous lorsque has_more vaut false.

curl "https://rest.boxhero-app.com/v1/items?cursor=1234567" \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"

Conservez les mêmes filtres que lors du premier appel pour tous les appels suivants.

Ordre

Chaque ressource définit son propre ordre. La plupart des endpoints de liste renvoient les résultats par id, dans l’ordre croissant. List transactions renvoie d’abord les transactions les plus récentes (par heure de transaction, l’id servant à départager les égalités).