Retrieve All Workspaces

GET

/v1/workspaces

Fetch all workspaces owned by the authenticated user.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Success - Workspaces retrieved successfully

Bodyapplication/json

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"
            }
        ]
    }
}

🟠401

Get Warmup Analytics for Mailboxes

Create New Workspace