Paginierung

Durchlaufen Sie lange Listen in der BoxHero API mit cursorbasierter Paginierung.

Listen-Endpunkte geben Ergebnisse seitenweise zurück und verwenden cursorbasierte Paginierung.

Abfrageparameter

Parameter	Beschreibung
`cursor`	Wo die Seite beginnt. Übergeben Sie das Feld `cursor` aus der vorherigen Antwort. Lassen Sie es beim ersten Aufruf weg.
`limit`	Seitengröße. Der zulässige Bereich und der Standardwert sind beim jeweiligen Endpunkt angegeben, zum Beispiel bei List items.

Antwort

Jede Seite enthält die Ergebnisse sowie die Felder, die Sie zum Abrufen der nächsten Seite benötigen:

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

Feld	Beschreibung
`count`	Anzahl der Ergebnisse auf dieser Seite
`limit`	Für diese Seite verwendete Seitengröße
`cursor`	Übergeben Sie diesen Wert als Abfrageparameter `cursor`, um die nächste Seite abzurufen. `null`, wenn es keine weiteren Seiten gibt.
`has_more`	`true`, wenn nach dieser Seite weitere Ergebnisse folgen

Alle Seiten abrufen

Rufen Sie den Listen-Endpunkt ohne cursor auf.
Solange has_more true ist, rufen Sie ihn erneut auf und setzen cursor auf den cursor aus der letzten Antwort.
Hören Sie auf, wenn has_more false ist.

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

Verwenden Sie bei allen folgenden Aufrufen dieselben Filter wie beim ersten Aufruf.

Reihenfolge

Jede Ressource legt ihre eigene Reihenfolge fest. Die meisten Listen-Endpunkte geben Ergebnisse aufsteigend nach id zurück. List transactions gibt die neuesten Transaktionen zuerst zurück (nach Transaktionszeit, bei Gleichstand nach id).