Retrieve Workspaces – BlueDolphin

Here you can find the steps for retrieving all existing workspaces for a specific tenant.

HTTP responses

HTTP response status code	Interpretation
200 OK	A list of workspaces retrieved successfully
401 Unauthorized	Invalid or missing API key secret and/or tenant

To retrieve the list of workspaces for a given tenant, make a GET request to the /workspaces endpoint specifying:

Resource/endpoint destination URL
The header for your API request

In this example, we want to retrieve the list of existing workspaces for the tenant yourtenantname. To get the list, we will pass a GET request to the URI https://public-api.eu.bluedolphin.app/v1/workspaces.

curl -L 'https://public-api.eu.bluedolphin.app/v1/workspaces' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json'

Response properties

Property	Type	Description
[].id	string	Unique identifier for the workspace
[].name	string	The name of the workspace
[].status	integer	The status of the workspace. Possible values are: 1 (not ready for use, the workspace is still being copied) and 0 (the workspace is ready for use).
[].is_root	boolean	Indicates if the workspace is root or not. The root workspace is immutable and is the main (or master) workspace.

A successful call returns a response with a 200 OK HTTP status code and the following array:

[
    {
        "id": "95c720561359c48a8eefa7b0",
        "name": "Company Main",
        "status": 0,
        "is_root": true
    },
    {
        "id": "64366bf99418b8a0978b448f",
        "name": "Company France",
        "status": 0,
        "is_root": false
    }
]

HTTP responses

Response properties

Related articles