Requests the details of organisations visible to the authenticated user.
Note: This call is not available for the X-Drive system.
(required)
The authentication token received in response to the call to POST authentication_credentials or GET authentication_token. Applications should pass the authentication token in the custom "X-auth" HTTP header to avoid passing it in in the query string.
(optional)
Indicates that only organisations from the specified system should be returned.
(optional)
Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.
(optional)
Only available for JSON format. If supplied, the response will contain JSON dates serialized in the specified format. 0 = Timestamp with offset e.g. "\/Date(1346080140000+0500)\/". 2 = ISO8601 e.g. "2012-08-27T15:09:00.0000000+05:00". Applications may pass this parameter in the custom "X-DateFormat" custom HTTP header instead of this query parameter.
(optional)
The authenticated user's globalisation preferences as received in response to the call to GET account/profile or in the custom "X-Globalisation" HTTP header returned in response to authenticated calls. Applications should pass this back to the server with every call, either in this parameter, or in the the custom "X-Globalisation" HTTP header if automatic conversion of values is required.
N/A
Returns a collection of one or more Organisation resources in the requested format.
application/json, application/javascript (JSONP), application/xml or text/csv as requested
Enter appropriate parameter values then click on the link which appears to try the API call...
Note: You must have JavaScript support enabled in your browser to use this feature.
auth
(required)
system_type
(optional)
callback
(optional)
date_format
(optional)
globalisation
(optional)
Response format
GET /organisations?auth=e722fa0c702f42b68e2fdb771a80caed GET /organisations.json?auth=e722fa0c702f42b68e2fdb771a80caed GET /organisations.xml?auth=e722fa0c702f42b68e2fdb771a80caed GET /organisations.csv?auth=e722fa0c702f42b68e2fdb771a80caed GET /organisations.json?auth=e722fa0c702f42b68e2fdb771a80caed&system_type=AssetManagement
JSON body:
[{"SystemType":"AssetManagement","OrganisationId":"4afb2205-7138-44f6-a268-cde80211fd76","Name":"FirmwareTestAccount"}]
XML body:
<?xml version="1.0"?>
<ArrayOfOrganisation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Organisation SystemType="AssetManagement" OrganisationId="4afb2205-7138-44f6-a268-cde80211fd76">
<Name>FirmwareTestAccount</Name>
</Organisation>
</ArrayOfOrganisation>
CSV body:
SystemType,OrganisationId,Name
AssetManagement,4afb2205-7138-44f6-a268-cde80211fd76,FirmwareTestAccount