Daten seitenweise abrufen

Einige Endpunkte sind darauf ausgelegt, viele hundert Datensätze bereitzustellen. In diesen Fällen verwendet die API Pagination, um seitenweise nach und nach die Datensätze bereitzustellen.

campflow verwendet eine Cursor-basierte Pagination.

Schritt 1: Cursor lesen

Im meta Schlüssel des Response Body befinden sich sowohl ein next_cursor als auch ein prev_cursor. Diese enthalten entweder

• null, falls es keine nächste bzw. vorherige Seite gibt oder
• einen kodierten String, der beim nächsten Abruf als Query Parameter übergeben werden kann, um die nächste bzw. vorherige Seite anzufragen

{
  "data": [
    {
      "id": "foo"
    },
    {
      "id": "bar"
    }
  ],
  "meta": {
    "path": "https://api.campflow.de/...",
    "per_page": 2,
    "next_cursor": "eyJwZXJ...",
    "prev_cursor": null
  }
}

Schritt 2: Cursor anwenden

Um eine bestimmte Seite mittels des Cursor-Strings aus Schritt 1 anzufragen, kann dieser einfach als Query Parameter cursor an den Endpunkt übergeben werden. Hier ein Beispiel:

https://api.campflow.de/lists/members/persons?cursor=eyJwZXJ...

Die Schlüssel next_cursor und prev_cursor in der Antwort auf diese Anfrage beziehen sich relativ zur angefragten Seite.

Wird kein Cursor übergeben wird die erste Seite zurückgegeben.