Switching Workspaces

Easily switch your user account between workspaces.

Workspaces allow you to create separate spaces for your applicants, entities, flows, and more. You may want to use workspaces for different teams or partners.

Use this endpoint to switch workspaces, so you can access its data.

Switch workspaces

POST /api-change-workspace

Switch to another workspace

Headers

Name	Value
Content-Type	multipart/form-data
Authorization	Bearer YOUR_TOKEN

Body

Name	Type	Description
workspace	string	The name of the workspace you'd like to switch to (Required)

Request

cURL

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-change-workspace' \
--form 'workspace="XYZ Co"'

Response

200 - OK

{
    "status": "success",
    "response": {
        "currentWorkspace": "XYZ Co"
    }
}

200 - Error

{
    "status": "error",
    "response": "Workspace not found"
}

Within the response, you'll receive the workspace your user has been switched to. From there, you can call the API as normal and access the data within your current workspace.

Workspaces act as a hierarchal structure. Users added to a Workspace can access all Workspaces beneath them, but not above.

Ensure your user, or API user, sits at the primary workspace to ensure it has access to all workspaces.