> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://support.robaws.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API - Filterung, Paginierung und Sortierung

## Filterung nach Standardfeldern

Jede Root-Entitätensammlung (root entity collection ressource) enthält spezifische Filterparameter.

Wenn du zusätzliche Filteranforderungen hast, die die Leistung deiner API-Nutzung verbessern könnten, sag uns bitte unter [support@robaws.com](mailto:support@robaws.com) Bescheid. Wir prüfen deine Anfrage.

---

## Filterung nach Zusatzfeldern

Die Filterung nach Zusatzfeldern ist mithilfe der folgenden URL-Syntax möglich.

Beachte, dass die Zeichen `[` und `]` in der URL kodiert sein müssen!




**Text, Link, Auswahlfelder**

GET /api/v2/articles?extraFields[DeinFeldname]=TextValue


**Boolean-Felder**

GET /api/v2/articles?extraFields[DeinFeldname]=true

GET /api/v2/articles?extraFields[DeinFeldname]=false


**Ganzzahl- und Dezimalfelder**

GET /api/v2/articles?extraFields[DeinFeldname]=90

GET /api/v2/articles?extraFields[DeinFeldname]=3.67


**Datumsfelder**

GET /api/v2/articles?extraFields[DeinFeldname]=2026-10-31

---


## Einbinden verwandter Ressourcen

Die GET-Endpoints in unserer API bieten einen optionalen 'include'-Query-Parameter **(*Abfrageparameter)***.

Damit kannst du die benötigten verschachtelten Verknüpfungen in die Antwort aufnehmen, ohne mehrere GET-Anfragen ausführen zu müssen.

Wenn du den 'include'-Parameter nicht angibst, geben wir standardmäßig nur die ID-Werte für Viele-/Eins-zu-eins-Verknüpfungen zurück.

**Beispiel**

GET /api/v2/employees?include=employer,employer.contacts,certificates

---


## Paginierung

Jede Root-Entitätensammlung ist mit den Query-Parametern `offset` und `limit` paginiert. Beachte, dass die maximale Seitengröße 100 beträgt. Die Standard-Seitengröße beträgt 10.

Um vorhersehbare Sortierergebnisse zu erhalten, fügen wir eine Standardsortierung hinzu, wenn keine angegeben ist.

Die Paginierungsantwort enthält Informationen darüber, wie viele Seiten es bei den angegebenen Seiten- und Größenwerten gibt.


**Beispiel**

GET /api/v2/employees?page=0&size=10 //erste Seite

GET /api/v2/employees?page=1&size=10 //zweite Seite

---


## Sortierung

Jede Root-Entitätensammlung ist mit dem Query-Parameter 'sort' sortierbar.

**Beispiel**

GET /api/v2/employees?sort=surname:asc,name:desc'''