List Workspaces

Lists the workspaces in the user's current unit.

This endpoint requires the Agent Impersonator role.

URL

GET: https://[base-url]/{applicationId}/agents/{userId}/workspaces

Headers

Authorization: Bearer <accessToken>

Request Body

N/A

Response

Success -> 200

An array of Workspace objects.

Sample response:

[
    {
        "workspaceId": "1b3ab45f-883c-4f56-8a7b-529841965110",
        "workspaceName": "Default",
        "description": null,
        "startNextBehavior": "Auto"
    },
    {
        "workspaceId": "3798fb8f-042d-40cb-91ef-afeef95ba68e",
        "workspaceName": "Sales",
        "description": null,
        "startNextBehavior": "CloseActiveTabs"
    },
    {
        "workspaceId": "899f29fa-a91f-4699-a8ed-5e2dd478da87",
        "workspaceName": "Tech. Support",
        "description": null,
        "startNextBehavior": "AddTab"
    }
]