PlanDocket

Paginierung

Wie Sie durch große Ergebnismengen navigieren.

Paginierungs-Parameter

Parameter Typ Standard Beschreibung
page integer 1 Seitennummer (beginnt bei 1)
per_page integer 25 Anzahl Ergebnisse pro Seite (max. 100)

Beispiel

GET /api/v1/events?page=2&per_page=25

Paginierte Antwort

{
  "data": [...],
  "meta": {
    "current_page": 2,
    "per_page": 25,
    "total": 150,
    "total_pages": 6
  }
}

GET /api/v1/notes ist ebenfalls paginiert; das "meta"-Objekt enthält zusätzlich entity_type und entity_id.

Nicht paginierte Listen

Einige Listen sind von Natur aus klein und liefern immer alle Einträge in einer Antwort, ohne "meta" und ohne Berücksichtigung von page/per_page:

  • GET /api/v1/categories?hierarchical=1 (der vollständige Kategoriebaum; ohne hierarchical=1 ist die Liste paginiert)
  • GET /api/v1/webhooks (die Webhooks des aufrufenden API-Schlüssels)
  • GET /api/v1/custom-fields/definitions (alle Felddefinitionen)
API Version v1.0