Lists Org Units.

get

https://api.personio.de/v2/org-units

Returns a paginated list of Org Units for the authenticated company.

Use the type parameter to filter by Org Unit type (e.g. department or team).
Use limit and cursor to paginate through large result sets.
Use sort to control the order of results by name or id, in ascending or descending order.
Optionally include the ancestor chain for each Org Unit by setting include_parent_chain=true.
Note: This endpoint is in beta mode. Please use the discussion page in the Developer Hub for feedback.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

required

The type of the Org Unit to be retrieved, e.g. team or department.

include_parent_chain

boolean

Defaults to false

Whether or not to include the Parent Org Unit Chain of the requested Org Unit in the response.
When used on the single-resource endpoint, each Org Unit in the chain includes full details (e.g. name, description, abbreviation). When used on the list endpoint, only the Org Unit IDs are returned.
Starts from the requested Org Unit's parent to the last chained Org Unit.
The parent_id property can be used to assert the link between Org Units.

sort

string

enum

Defaults to id

Defines the sort order of results.

Use field names for ascending (e.g., name)
Use a minus sign for descending (e.g., -name)
Supported sort fields are name and id.
If no sort is provided, results are returned sorted by id in ascending order.

Allowed:

limit

integer

1 to 100

Defaults to 20

The number of Org Units to be returned per request. It can range between 1 and 100, and the default is 20.

cursor

string

The pagination cursor to navigate to the next list of resources. If cursor is missing, the first page is returned.

Headers

Beta

string

required

As this is a Beta endpoint, the Beta header must be provided with the value true.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication information is missing or invalid.

403

The request is understood, but authorization is refused or insufficient.

200Successful response.

400The current request is invalid. Please make sure you pass all the required parameters and you are using the proper content-type.

412The Org Unit feature is disabled.