Paginierung
Solange Sie Listen von Daten abfragen, gibt unsere REST-API grundsätzlich paginierte Antworten zurück. Standardmäßig sind die Responses auf 15 Ergebnisse pro Seite beschränkt, Sie können diese aber mit dem limit Parameter auf bis zu 100 Ergebnisse pro Seite erweitern.
Aufbau der paginierten Response
In den Responses sind die Objekte in einem data Attribut verschachtelt und die Metadaten in einem meta Attribut. Dort finden Sie unter anderem auch die Angaben, wie viele Seiten last_page existieren und auf welcher Seite current_page Sie sich gerade befinden. Ergänzend zu den zuvor genannten Attributen gibt es ein links Attribut mit den URLs zu den vorherigen und nächsten Seiten.
Die Paginierung wird in der Dokumentation unserer Ressourcen in den Responses ausgeblendet.
Beispiel mit Limit-Parameter
In diesem Beispiel senden wir einen Request an den Endpunkt /api/v1/projects und geben mithilfe des limit Parameters an, dass die Ergebnisse auf 20 Einträge pro Seite begrenzt werden sollen.
{
"data":[
{
"id":"WAz8eIbvDR60rouK"
},
{
"id":"hSIhXBhNe8X1d8Et"
},
{
"id":"fbwYwpi9C2ybt6Yb"
}
],
"links":{
"first":"https://www.zep-online.de/zepinstanz/next/api/v1/projects?page=1",
"last":"https://www.zep-online.de/zepinstanz/next/api/v1/projects?page=2",
"prev":"https://www.zep-online.de/zepinstanz/next/api/v1/projects?page=1",
"next":null
},
"meta":{
"current_page":2,
"from":21,
"last_page":2,
"links":[
{
"url":"https://www.zep-online.de/zepinstanz/next/api/v1/projects?page=1",
"label":"« Previous",
"active":false
},
{
"url":"https://www.zep-online.de/zepinstanz/next/api/v1/projects?page=1",
"label":"1",
"active":false
},
{
"url":"https://www.zep-online.de/zepinstanz/next/api/v1/projects?page=2",
"label":"2",
"active":false
},
{
"url":null,
"label":"Next »",
"active":false
}
],
"path":"https://www.zep-online.de/zepinstanz/next/api/v1/projects",
"per_page":20,
"to":32,
"total":32
}
}