Skip to main content
GET
List divisions

Auf einen Blick

Betriebsverhalten

Listet Divisionen im Scope des API-Keys auf. Filter- und Sortierfelder: id, tenant, name, parentId, order, costCenter, createdAt, updatedAt.
  • Verwenden Sie parentId und order, um die Tenant-Hierarchie zu rekonstruieren.

Häufige Fehler

Die Response-Liste der Operation und die Seite Fehlerbehandlung sind für die vollständige Behandlung maßgeblich.

Vor der Implementierung

  • Erzeugen und protokollieren Sie für den Versuch eine neue X-Request-ID.
  • Behandeln Sie jeden dokumentierten Response-Status.
  • Protokollieren Sie weder X-API-Key noch unnötige personenbezogene Daten.

Zugehöriger Integrationsleitfaden

Prüfen Sie den vollständigen Prozess sowie Status-, Retry- und Betriebsmuster für diese Operation.

Autorisierungen

X-API-Key
string
header
erforderlich

JobHandy integration API key. Send the credential in the X-API-Key header. Treat the key as a secret and use it only from trusted server-side environments.

Header

X-Tenant-ID
string
inactive
optional
not sent by default

Restricts results to one tenant in the API key's scope. Omit the header to query all tenants in scope. In interactive clients, use the {{tenantId}} variable when a tenant must be selected. Keep the header disabled when tenant selection is not required.

Pattern: ^[0-9a-fA-F]{24}$
X-Request-ID
string<uuid>
inactive
optional
not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Abfrageparameter

page
integer
inactive
optional
server default: 1
not sent by default

One-based page number. When omitted, the server uses 1.

Erforderlicher Bereich: x >= 1Muss ein Vielfaches sein von 1
Beispiel:

1

pageSize
integer
inactive
optional
server default: 100
not sent by default

Number of resources per page. When omitted, the server uses 100.

Erforderlicher Bereich: 1 <= x <= 1000Muss ein Vielfaches sein von 1
Beispiel:

100

sort
string
inactive
optional
not sent by default

One endpoint-supported public scalar field. Prefix with - for descending order. Multiple fields and whitespace are rejected. Null values sort first in ascending order and last in descending order.

filter
string
inactive
optional
not sent by default

Expression over endpoint-supported public scalar fields. Operators: =, !=, >, >=, <, <=, IN (...), CONTAINS, STARTS_WITH, ENDS_WITH, IS NULL, IS NOT NULL. AND binds before OR; parentheses override precedence. Whitespace outside quoted values is ignored. String comparisons are case-insensitive. String values may be unquoted, single-quoted, or double-quoted. Values containing whitespace must be enclosed in single or double quotes. An apostrophe may be escaped as ' in either quote style; the escape backslash is not part of the matched value. Nested, object, and array fields are rejected. Examples show decoded filter expressions; URL-encode the query parameter value when constructing a raw URL.

createdAtFrom
string<date-time>
inactive
optional
not sent by default

Inclusive lower bound for createdAt. Must be an ISO-8601 UTC timestamp ending in Z.

Pattern: Z$
Beispiel:

"2026-01-01T00:00:00.000Z"

createdAtTo
string<date-time>
inactive
optional
not sent by default

Inclusive upper bound for createdAt. Must be an ISO-8601 UTC timestamp ending in Z.

Pattern: Z$
Beispiel:

"2026-12-31T23:59:59.999Z"

Antwort

A page of divisions.

One page of divisions.

page
integer
erforderlich

Current one-based page number.

Muss ein Vielfaches sein von 1
Beispiel:

1

pageSize
integer
erforderlich

Maximum number of resources returned per page.

Muss ein Vielfaches sein von 1
Beispiel:

100

totalPages
integer
erforderlich

Number of available pages.

Muss ein Vielfaches sein von 1
Beispiel:

1

totalElements
integer
erforderlich

Number of resources matching the request.

Muss ein Vielfaches sein von 1
Beispiel:

2

items
object[]
erforderlich

Divisions on the current page.

Zuletzt geändert am 27. August 2026