Zum Inhalt springen
WorkLogx
Menü· Pagination & Filter

Vorschau: Diese Dokumentation beschreibt die WorkLogx Public API V1. Die Bereitstellung von V1 in der Produktionsumgebung ist noch nicht abgeschlossen.

Pagination & Filter

Alle acht Listen-Endpunkte (GET /v1/employees, /v1/customers, /v1/projects, /v1/tasks, /v1/forms, /v1/submissions, /v1/absences, /v1/worklogs) verwenden Cursor-Pagination.

#Parameter

ParameterBeschreibung
limitSeitengröße, 1 bis 100. Standard 50. Werte außerhalb ergeben 400 invalid_limit.
cursorOpaker Wert aus nextCursor der vorherigen Seite. Ungültige Werte ergeben 400 invalid_cursor.
updatedAfterISO-8601-Zeitpunkt, zum Beispiel 2026-10-01T00:00:00Z. Liefert nur Datensätze, deren updatedAt echt danach liegt.

#Antwort

{
  "data": [ ... ],
  "nextCursor": "MjAyNi0xMC0zMFQwOToyNzo1NVp8OGExZDRmN2MtMmI5ZS00YzNhLWE2ZjEtN2UyZDliMGM1ZjE4"
}

Datensätze sind aufsteigend nach updatedAt und danach nach id sortiert. Gibt es weitere Datensätze, enthält die Antwort nextCursor. Auf der letzten Seite fehlt nextCursor. Behandeln Sie den Cursor als opak: nicht auswerten und nicht selbst bauen.

#Alle Seiten laden

nextCursor als cursor übergeben und auf jeder Seite dieselben Filter wiederholen:

curl "https://api-test.worklogx.com/api/v1/customers?limit=100" \
  -H "Authorization: Bearer wlx_test_YOUR_API_KEY"

curl "https://api-test.worklogx.com/api/v1/customers?limit=100&cursor=NEXT_CURSOR" \
  -H "Authorization: Bearer wlx_test_YOUR_API_KEY"

#Inkrementeller Abgleich mit updatedAfter

  1. Beim ersten Lauf die gesamte Liste durchblättern und den höchsten erhaltenen updatedAt-Wert merken.
  2. Beim nächsten Lauf die Liste mit updatedAfter auf diesen Wert abfragen und alle Seiten laden.
curl "https://api-test.worklogx.com/api/v1/projects?updatedAfter=2026-10-30T09:27:55Z" \
  -H "Authorization: Bearer wlx_test_YOUR_API_KEY"

Der Vergleich ist „echt größer“. Ein Datensatz, dessen updatedAt genau dem gespeicherten Wert entspricht, wird nicht erneut geliefert.

#Weitere Filter

EndpunktFilter
GET /v1/tasksprojectId
GET /v1/submissionsformId, projectId, customerId, taskId
GET /v1/absencesemployeeId, status, dateFrom, dateTo
GET /v1/worklogsemployeeId, customerId, projectId, dateFrom, dateTo
  • IDs sind UUIDs. Eine ID einer anderen Organisation ergibt eine leere Seite, keinen Fehler.
  • dateFrom und dateTo sind Datumswerte (YYYY-MM-DD). Liegt dateFrom nach dateTo, folgt 400 invalid_date_range. Bei Abwesenheiten trifft der Filter Abwesenheiten, deren Zeitraum den Bereich überschneidet.
  • status bei Abwesenheiten ist einer von PENDING, APPROVED, REJECTED, CANCELLED, REPORTED. Andere Werte ergeben 400 invalid_status.