Work Space

Retrieve Workspaces

GET

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.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
$curl /api/data/workspaces \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": [
13    {
14      "id": "id",
15      "company": "company",
16      "customProductDomain": "customProductDomain",
17      "customerId": "customerId",
18      "isOwner": true,
19      "organizationId": "organizationId",
20      "color": "color",
21      "roleName": "roleName",
22      "registerDate": "2024-01-15T09:30:00Z",
23      "isInviteAccepted": true,
24      "businessUserId": "businessUserId",
25      "isPaid": true
26    }
27  ]
28}
Built with