Get Organization Unit

GET

/orgunits/{orgid}

Organization Units

Returns information about the specified organization unit.
The response includes the display name, internal and external id and client number.

Response Example

200 - Example 1

{
    "externalId": "string",
    "id": 0,
    "name": "string",
    "parentId": 0,
    "type": "string"
}

Request

Path Params

orgid

integer

required

Id of the organization unit

🟢200A response with an organization unit

application/json

Body

externalId

string

optional

The external id (foreign key). Must not exceed 255 characters.

integer <int64>

required

Unique identifier representing a specific organization unit. Id numbers are never reused.

name

string

optional

The name of the client.

parentId

integer <int64>

optional

Unique identifier of the parent or null if there is no parent.

type

string

required

The organization unit type. The only type is client at the moment.

🟠404Organization Unit not found

🔴500Unexpected error