Overview

WiredUp has the option to return the portfolio or the organisational structure on the API. The API returns the site/portfolio name with its descendants (or children). It also includes the ID associated with each level of the org structure, as well as the Owner of each level of the org structure. 

The org structure returned on the API is based on the user's permission access to the org structure. If the user does not have access to the site, an unauthorised error is returned.

Note: this API is available on the V3 definition endpoint

IncludeSiteName Parameter

The IncludeSiteName parameter is included to the API call when the user would like to return the org structure for a specific site. The parameter is included in the URL as follows:

Note: remember to include your API key to the URL for authentication purposes

The API will return data for all sites when the IncludeSiteName parameter is not included on the API call.

Available Parameters

These are the available parameters for the Organisational Structure API:

• IncludeSiteName

Note: The available API parameters can be accessed on Swagger