Get Organization Unit with External Id

GET

/extorgunit

Organization Units

Returns information about the organization unit with the specified external id.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://learnifier.com/extorgunit?extid='

Response Example

200 - Example 1

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

Request

Query Params

extid

string

required

The external 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