Retrieve all workspaces

GET

/v2/workspaces

Use this endpoint to retrieve a list of all workspaces associated with the authenticated user. You can filter the results using pagination parameters and an optional search keyword.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Default sort order: ascending by creation time (oldest first, newest last).

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zapmail.ai/api/v2/workspaces?page=1%2C2%2C3...&limit=10%2C%2050%2C%20100&contains=tryzapmail.com' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Response Example

{
    "status": 200,
    "message": "Workspaces fetched successfully",
    "data": {
        "totalSearchedCount": 2,
        "currentPage": 1,
        "nextPage": 2,
        "totalPages": 1,
        "totalWorkspacesCount": 2,
        "totalDomainsCountGoogle": 12,
        "totalDomainsCountMicrosoft": 3,
        "totalPurchasedMailboxesCountGoogle": 50,
        "totalPurchasedMailboxesCountMicrosoft": 0,
        "totalDomainsCount": 18,
        "totalPurchasedMailboxesCount": 50,
        "currentWorkspace": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "John's Workspace",
            "role": "OWNER",
            "domainCountGoogle": "10",
            "domainCountMicrosoft": "2",
            "assignedMailboxesCountGoogle": "6",
            "assignedMailboxesCountMicrosoft": "2",
            "totalMailboxesPurchasedGoogle": "30",
            "totalMailboxesPurchasedMicrosoft": "0",
            "activeMailboxCountGoogle": "5",
            "activeMailboxCountMicrosoft": "2",
            "domainCount": "13",
            "assignedMailboxesCount": "8",
            "activeMailboxCount": "7",
            "totalMailboxesPurchased": "30",
            "billingDetails": {
                "id": "987f6543-b21a-43c8-9876-543210fedcba",
                "firstName": "John",
                "lastName": "Doe",
                "company": "TechCorp",
                "country": "US"
            }
        },
        "workspaces": [
            {
                "id": "789d1234-e56b-78c9-a123-098765432112",
                "name": "Jane's Workspace",
                "role": "ADMIN",
                "domainCountGoogle": "2",
                "domainCountMicrosoft": "1",
                "assignedMailboxesCountGoogle": "4",
                "assignedMailboxesCountMicrosoft": "0",
                "totalMailboxesPurchasedGoogle": "20",
                "totalMailboxesPurchasedMicrosoft": "0",
                "activeMailboxCountGoogle": "4",
                "activeMailboxCountMicrosoft": "0",
                "domainCount": "5",
                "assignedMailboxesCount": "4",
                "activeMailboxCount": "4",
                "totalMailboxesPurchased": "20",
                "billingDetails": {
                    "id": "54321fed-cba9-8765-4321-0fedcba98765",
                    "firstName": "Jane",
                    "lastName": "Smith",
                    "company": "Innovatech",
                    "country": "US"
                }
            }
        ]
    }
}

Modified at 2026-10-13 07:49:49

Delete A Workspace

Create new workspace