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.

Headers

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

datalist of objectsOptional

If the API call succeeded, this will contain the results.

GET

1 curl https://api.projectmanager.com/api/data/workspaces \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "error": {
3     "technicalError": "technicalError",
4     "additionalErrors": [
5       "additionalErrors"
6     ],
7     "validationErrors": {
8       "key": [
9         "value"
10       ]
11     },
12     "message": "message"
13   },
14   "success": true,
15   "hasError": true,
16   "statusCode": "Continue",
17   "data": [
18     {
19       "id": "id",
20       "company": "company",
21       "customProductDomain": "customProductDomain",
22       "isOwner": true,
23       "organizationId": "organizationId",
24       "color": "color",
25       "roleName": "roleName",
26       "registerDate": "2024-01-15T09:30:00Z",
27       "businessUserId": "businessUserId",
28       "isPaid": true,
29       "customerId": "customerId",
30       "isInviteAccepted": true
31     }
32   ]
33 }

Invite to Workspace

Up Next

Built with

1	curl https://api.projectmanager.com/api/data/workspaces \
2	-H "Authorization: Bearer <token>"

1	{
2	"error": {
3	"technicalError": "technicalError",
4	"additionalErrors": [
5	"additionalErrors"
6	],
7	"validationErrors": {
8	"key": [
9	"value"
10	]
11	},
12	"message": "message"
13	},
14	"success": true,
15	"hasError": true,
16	"statusCode": "Continue",
17	"data": [
18	{
19	"id": "id",
20	"company": "company",
21	"customProductDomain": "customProductDomain",
22	"isOwner": true,
23	"organizationId": "organizationId",
24	"color": "color",
25	"roleName": "roleName",
26	"registerDate": "2024-01-15T09:30:00Z",
27	"businessUserId": "businessUserId",
28	"isPaid": true,
29	"customerId": "customerId",
30	"isInviteAccepted": true
31	}
32	]
33	}