GET api/v1/OrganizationalUnits/{id}
Get an Organizational Unit by its ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID being requested |
globally unique identifier |
Required |
| fields |
Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned. |
Collection of string |
None. |
| suppressResponseCodes |
Some applications do wonky things if error codes are used. Use this to force 200s to always return. |
boolean |
None. |
| APIKey |
This is your unique key that identifies you as the developer of this app. Required for all calls. |
string |
None. |
| APIToken |
This is the user's session token generated when you authenticate the user |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
OrganizationalUnit| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The ID of the OU |
globally unique identifier |
None. |
| Name |
The name of the OU |
string |
None. |
| ParentID |
The ID of the parent OU. This will be null if this OU is a root OU. |
globally unique identifier |
None. |
| ExternalID |
The external ID of the OU. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": "273027c8-81bf-4e39-80c1-8b1dd6b78be0",
"Name": "sample string 2",
"ParentID": "3662d438-aea4-406d-b67c-a72e988d60f8",
"ExternalID": "sample string 3"
}