Retrieves an Org Unit.

  • Returns the requested Org Unit.
  • Supports enriching the response by providing options via query params, e.g. include_ancestors.
Path Params
int64
required

The ID of the Org Unit to be retrieved, e.g. the Org Unit ID associated with an Employment OR the Parent ID of another Org Unit.

Query Params
string
required

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

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.
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json