Retrieves an organization unit

GET 
/organization-units/:organizationUnitId

Retrieves an organization unit

Request

Path Parameters

organizationUnitId UuidOrReferencerequired

Id of the specified organization unit

Responses

200

OK

application/json

Schema

Schema

id string
reference string
name stringrequired
internal_name string

parent_id

object

oneOf

UuidOrReference

string

NullableObject

object

created_at date-time
updated_at date-time
deleted_at date-time

Example (from schema)

{
  "id": "string",
  "reference": "string",
  "name": "string",
  "internal_name": "string",
  "parent_id": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "deleted_at": "2024-07-29T15:51:28.071Z"
}

401

Unauthenticated

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

403

Unauthorized

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

404

Not found

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

422

Unprocessable Entity

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

500

Unknown error

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

Loading...