Get site

This is the latest version of this API endpoint valid from Collaborate 4.3 and above, for older versions please see the child pages of this page

The get site API returned the details for a site. Anyone with site access in Collaborate is permitted to use this API endpoint.

The fields returned for the site object are determined based on user permissions. If the user is a site admin user then they will get fields like Admin Notes otherwise not.

The current implementation does not include logo link. 

The response object contains the user ID of the site owner.

The API responds with an access denied message when “My site” details of another user are accessed. 

Blank values for individual fields are not returned in the XML response, absence of value in the returned XML means that either the value does not exist for that field or the user does not have access to that field.

Request

Parameters
 

Response

The API returns a site object   

In the case of an invalid site ID an error object is returned.

Please note that the site parameter is permissions specific, and only site admins will be returned the size of a site.