GET api/v1/OrganizationalUnits/ByExternalID/{externalID}

Retrieve an OU(s) by its external ID (could be multiple if identical external IDs exist)

Request Information

URI Parameters

Name	Description	Type	Additional information
externalID	The external ID being requested	string	Required
q	A query parameter. Use this to limit the result set. ?q[fieldName1]=value1&q[fieldName2]=value2	Dictionary of string [key] and string [value]	None.
limit	The number of records returned, default is 20	integer	None.
offset	The offset from the start of the list of values, default is 0	integer	None.
orderBy	Orders the list that comes down to the field name provided. If not provided then the default ordering will be used.	string	None.
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

PaginatedResultsOfOrganizationalUnit

Name	Type	Additional information
limit	integer	None.
offset	integer	None.
totalRecordCount	integer	None.
data	Collection of OrganizationalUnit	None.

Response Formats

application/json, text/json

Sample:

{
  "limit": 1,
  "offset": 2,
  "totalRecordCount": 3,
  "data": [
    {
      "ID": "18469900-d423-4ecd-9f55-3c8f2a920c4d",
      "Name": "sample string 2",
      "ParentID": "e4addad2-a348-41eb-9e06-d2d45e279460",
      "ExternalID": "sample string 3"
    },
    {
      "ID": "18469900-d423-4ecd-9f55-3c8f2a920c4d",
      "Name": "sample string 2",
      "ParentID": "e4addad2-a348-41eb-9e06-d2d45e279460",
      "ExternalID": "sample string 3"
    }
  ]
}