Retrieve All Workspaces

GET

/v1/workspaces

Fetch all workspaces owned by the authenticated user.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer eyJhbGciOiJSUzI1NiIsImNhdCI6ImNsX0I3ZDRQRDExMUFBQSIsImtpZCI6Imluc18zM1FqbUNRdUNYcU1USUpxeVZvYXVXNUtWckgiLCJ0eXAiOiJKV1QifQ.eyJhenAiOiJodHRwczovL2FwcC5saXRlbWFpbC5haSIsImV4cCI6MTc2OTcyNTc2NSwiZnZhIjpbMCwtMV0sImlhdCI6MTc2OTcyNTcwNSwiaXNzIjoiaHR0cHM6Ly9jbGVyay5saXRlbWFpbC5haSIsIm5iZiI6MTc2OTcyNTY5NSwic2lkIjoic2Vzc18zOHd6dlhoM0N5Vm16a0NsaGk0MWx6WEhoTXciLCJzdHMiOiJhY3RpdmUiLCJzdWIiOiJ1c2VyXzM0aEk2THFBazNPdUlWVDNaZmpuYldRY2pPMiIsInYiOjJ9.2C1vleGX50Q3Z7D1HTH_3xGaTrxnEVwBc1n1EsqZSjQFKriztJXv7VYRUsBRIDH4npejsCcZagNctwS6Hz8tiS_7ggC22UGJbOENmTQCB7V8Ejcl6hC_qH-9Ovmi_6kcmQ9pwT6W4yWSelpm_jDVkDGmGS6GBEsupZYL-FKZpTPGdvlRP0JF8c1U6Z_XaXUH63DHQkcRYMxcQCmZEH7I6jPbyKgUxcL2n7tdBHZcrxAOp5vYlP4Q9aViaVI_ETkDAPm4GqrzL2y5UZKo-mwaiyj4diYX3p1stnHsYgV09MVQny-TCKsoJ_DEukt85GCyWe2SiwA32eCGp5eU-lKnTw.

Example:

Authorization: Bearer eyJhbGciOiJSUzI1NiIsImNhdCI6ImNsX0I3ZDRQRDExMUFBQSIsImtpZCI6Imluc18zM1FqbUNRdUNYcU1USUpxeVZvYXVXNUtWckgiLCJ0eXAiOiJKV1QifQ.eyJhenAiOiJodHRwczovL2FwcC5saXRlbWFpbC5haSIsImV4cCI6MTc2OTcyNTc2NSwiZnZhIjpbMCwtMV0sImlhdCI6MTc2OTcyNTcwNSwiaXNzIjoiaHR0cHM6Ly9jbGVyay5saXRlbWFpbC5haSIsIm5iZiI6MTc2OTcyNTY5NSwic2lkIjoic2Vzc18zOHd6dlhoM0N5Vm16a0NsaGk0MWx6WEhoTXciLCJzdHMiOiJhY3RpdmUiLCJzdWIiOiJ1c2VyXzM0aEk2THFBazNPdUlWVDNaZmpuYldRY2pPMiIsInYiOjJ9.2C1vleGX50Q3Z7D1HTH_3xGaTrxnEVwBc1n1EsqZSjQFKriztJXv7VYRUsBRIDH4npejsCcZagNctwS6Hz8tiS_7ggC22UGJbOENmTQCB7V8Ejcl6hC_qH-9Ovmi_6kcmQ9pwT6W4yWSelpm_jDVkDGmGS6GBEsupZYL-FKZpTPGdvlRP0JF8c1U6Z_XaXUH63DHQkcRYMxcQCmZEH7I6jPbyKgUxcL2n7tdBHZcrxAOp5vYlP4Q9aViaVI_ETkDAPm4GqrzL2y5UZKo-mwaiyj4diYX3p1stnHsYgV09MVQny-TCKsoJ_DEukt85GCyWe2SiwA32eCGp5eU-lKnTw ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/v1/workspaces' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImNhdCI6ImNsX0I3ZDRQRDExMUFBQSIsImtpZCI6Imluc18zM1FqbUNRdUNYcU1USUpxeVZvYXVXNUtWckgiLCJ0eXAiOiJKV1QifQ.eyJhenAiOiJodHRwczovL2FwcC5saXRlbWFpbC5haSIsImV4cCI6MTc2OTcyNTc2NSwiZnZhIjpbMCwtMV0sImlhdCI6MTc2OTcyNTcwNSwiaXNzIjoiaHR0cHM6Ly9jbGVyay5saXRlbWFpbC5haSIsIm5iZiI6MTc2OTcyNTY5NSwic2lkIjoic2Vzc18zOHd6dlhoM0N5Vm16a0NsaGk0MWx6WEhoTXciLCJzdHMiOiJhY3RpdmUiLCJzdWIiOiJ1c2VyXzM0aEk2THFBazNPdUlWVDNaZmpuYldRY2pPMiIsInYiOjJ9.2C1vleGX50Q3Z7D1HTH_3xGaTrxnEVwBc1n1EsqZSjQFKriztJXv7VYRUsBRIDH4npejsCcZagNctwS6Hz8tiS_7ggC22UGJbOENmTQCB7V8Ejcl6hC_qH-9Ovmi_6kcmQ9pwT6W4yWSelpm_jDVkDGmGS6GBEsupZYL-FKZpTPGdvlRP0JF8c1U6Z_XaXUH63DHQkcRYMxcQCmZEH7I6jPbyKgUxcL2n7tdBHZcrxAOp5vYlP4Q9aViaVI_ETkDAPm4GqrzL2y5UZKo-mwaiyj4diYX3p1stnHsYgV09MVQny-TCKsoJ_DEukt85GCyWe2SiwA32eCGp5eU-lKnTw <token>'

Responses

🟢200OK

application/json

Success - Workspaces retrieved successfully

Body

Example

{
    "status": 200,
    "message": "Workspaces fetched successfully",
    "data": {
        "userId": "cmg9jatbj0000jv04cejuz12b",
        "totalWorkspaces": 2,
        "workspaces": [
            {
                "id": "wks1",
                "name": "Development Workspace",
                "description": "Workspace for development team",
                "createdAt": "2025-10-01T12:00:00Z"
            },
            {
                "id": "wks2",
                "name": "Marketing Workspace",
                "description": "Workspace for marketing team",
                "createdAt": "2025-10-02T12:00:00Z"
            }
        ]
    }
}

🟠401Unauthorized

Retrieve User Details

Create New Workspace