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).

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.zapmail.ai/api/v2/workspaces?page=1,2,3...&limit=10, 50, 100&contains=tryzapmail.com' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Response Example

{
    "status": 200,
    "message": "Workspaces fetched successfully",
    "data": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "John's Workspace",
            "domainCount": "15",
            "mailboxCount": "8",
            "billingDetails": {
                "id": "987f6543-b21a-43c8-9876-543210fedcba",
                "userId": "123e4567-e89b-12d3-a456-426614174000",
                "firstName": "John",
                "lastName": "Doe",
                "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
                "company": "TechCorp",
                "addressLineOne": "123 Main Street",
                "addressLineTwo": "Suite 400",
                "addressLineThree": null,
                "city": "Metropolis",
                "state": "California",
                "country": "US",
                "postalCode": "90210",
                "phoneCc": "1",
                "phone": "5551234567",
                "languagePreference": "en"
            }
        },
        {
            "id": "789d1234-e56b-78c9-a123-098765432112",
            "name": "Jane's Workspace",
            "domainCount": "25",
            "mailboxCount": "12",
            "billingDetails": {
                "id": "54321fed-cba9-8765-4321-0fedcba98765",
                "userId": "789d1234-e56b-78c9-a123-098765432112",
                "firstName": "Jane",
                "lastName": "Smith",
                "workspaceId": "789d1234-e56b-78c9-a123-098765432112",
                "company": "Innovatech",
                "addressLineOne": "456 Elm Street",
                "addressLineTwo": "Apt 101",
                "addressLineThree": null,
                "city": "Gotham",
                "state": "New York",
                "country": "US",
                "postalCode": "10001",
                "phoneCc": "1",
                "phone": "5559876543",
                "languagePreference": "en"
            }
        }
    ]
}

Modified at 2025-10-14 09:20:16

Quick Setup

Create new workspace