API ReferenceWork Space

Retrieve Workspaces

Retrieve the list of Workspaces to which the currently logged on user has access.

A single User may have access to multiple Workspaces, although they can only be logged on to one Workspace at a time. This API lists all Workspaces to which the currently logged on user is entitled to access. To determine which Workspace a user is currently logged on use the /api/data/me endpoint.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successbooleanRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
datalist of objects
If the API call succeeded, this will contain the results.