Retrieves a list of organization units

GET 
/organization-units

Retrieves a list of organization units

Request

Query Parameters

filter object

Organization unit filter

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of organization units to return

cursor string

The cursor to use to retrieve the next page of organization units

Responses

200

OK

application/json

Schema

Schema

organizationUnits

object[]

The list of organization units

Array [

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

]

cursor

object

cursor

self string

Pagination link|cursor pointing to the current page.

first string

Pagination link|cursor pointing to the first page.

prev string

Pagination link|cursor pointing to the previous page.

next string

Pagination link|cursor pointing to the next page.

last string

Pagination link|cursor pointing to the last page.

Example (from schema)

{
  "organizationUnits": [
    {
      "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"
    }
  ],
  "cursor": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

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"
}

429

Too Many Requests

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...