Zapmail
OverviewAPI Reference
OverviewAPI Reference
  1. Subscriptions and Workspaces
  • Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Check DNS Records
      • Add DNS Records to Multiple Domains
      • Update DNS Record
      • Delete DNS Record
    • Register
      • Search Available Domains
      • Buy Domains
      • Check Availability of Multiple Domains
      • Find Domains With AI
    • Connect
      • List Domain Connection Requests
      • Connect Domains
      • Get Nameservers to Connect a Domain
      • Verify Nameservers to Connect a Domain
      • Add Google Client ID to Domains
      • Remove Domain Connection Requests
    • Tag
      • List Domain Tags
      • Assign Tags to Domains
      • Create Domain Tags
      • Remove Tags from Domains
      • Delete Domain Tag
      • Update Domain Settings
    • Renewals
      • Search Domains Due for Renewal
      • Get Domain Renewal Prices
      • Renew Domains
      • Update Domain Auto-Renew
      • List Domains Due for Renewal
    • List Assignable Domains
      GET
    • Get Domain Health Score
      GET
    • Search Mailboxes and Domains
      GET
    • List Domains
      POST
    • Move Domains to Another Workspace
      POST
    • Remove Connected Domains
      DELETE
  • Mailbox
    • Get Authenticator Code
      GET
    • Get Mailbox
      GET
    • List Mailboxes
      POST
    • Provision Mailboxes
      POST
    • Update Mailboxes
      PUT
    • Schedule Mailbox Removal
      PUT
    • Retry Failed Mailboxes
      PUT
  • Export
    • List Third-Party Workspaces
    • Add Sequencer Details
    • Get Export Status
    • Update Sequencer Account Details
    • Add Google Client ID To Domain
    • Connect Third-Party Account
    • Connect Mailboxes With Custom OAuth
    • Fetch Workspaces by App
    • Export Mailboxes
    • Update Third-Party Account
    • Get Export Status
    • Export Mailboxes
  • Quick Setup
    • List Quick Setup Entries
    • Start Quick Setup
  • Pre-Warmed
    • List Pre-Warmed Domains
    • Count Pre-Warmed Domains
    • List Pre-Warmed Subscriptions
    • Assign Pre-Warmed Domains
    • Purchase Pre-Warmed Plan
  • Zapbox
    • List Zapbox Connected Accounts
    • List Zapbox Threads
    • Get Zapbox Thread Messages
    • Search Zapbox Emails
    • Send Zapbox Email
    • Apply Zapbox Email Action
    • Download Zapbox Attachment
    • Create Zapbox Label
    • Delete Zapbox Label
    • Rename Zapbox Label
  • User
    • Get Current User
  • Billing Details
    • Add Billing Details
    • Update Billing Details
  • Payments & Wallet
    • Get Wallet Balance
    • Add Wallet Balance
    • Enable or Disable Auto Recharge
    • Buy Add-On Mailboxes
    • Get Subscription Invoice URL
  • Subscriptions and Workspaces
    • List Workspace Members
      GET
    • List Workspace Invitations
      GET
    • List Workspaces
      GET
    • List Subscriptions
      POST
    • Create Workspace
      POST
    • Send Workspace Invitation
      POST
    • Cancel Subscription
      POST
    • List Subscription Mailboxes
      POST
    • Update Member Role
      PUT
    • Update Workspace
      PUT
    • Revoke Workspace Access
      DELETE
  • High Reputation Domains
    • List Aged Domains
    • Purchase Aged Domains
  • Deliverability
    • ZapShield
      • List ZapShield Subscriptions
      • List ZapShield Eligible Domains
      • List ZapShield Allocated Domains
      • Get ZapShield Available Slots
      • Cancel ZapShield Subscription
      • Purchase ZapShield
      • Upgrade ZapShield Plan
      • Allocate Domains to ZapShield
    • Deliverability Test
      • Get Deliverability Test Overall Report
      • List Deliverability Test Orders
      • Get Deliverability Test Report
      • List Deliverability Test Subscriptions
      • Get Deliverability Test Available Slots
      • List Deliverability Test Eligible Mailboxes
      • Purchase Deliverability Test
      • Generate Deliverability Test Spintax
      • Purchase Deliverability Test Plan
      • Cancel Deliverability Test Subscription
    • AI Insight
      • Get AI Insight Credits
      • Get AI Insight Analysis
      • Get Shared AI Insight Analysis
      • List AI Insight Eligible Mailboxes
      • Generate AI Insight Analysis
      • Calculate AI Insight Pricing
      • Purchase AI Insight Plan
      • Purchase AI Insight For Mailboxes
      • Email AI Insight Analysis
      • Share AI Insight Analysis
      • List AI Insight Analyses
      • Upgrade AI Insight Plan
    • Zap Care
      • List Zap Care Allocated Domains
      • Get Zap Care Available Slots
      • List Zap Care Subscriptions
      • List Zap Care Eligible Domains
      • Cancel Zap Care Subscription
      • Allocate Domains to Zap Care
      • Purchase Zap Care
  • Webhooks
    • List Webhook Event Types
    • List Webhook Endpoints
    • List Webhook Deliveries
    • Get Webhook Endpoint
    • Create Webhook Endpoint
    • Resend Webhook Delivery
    • Send Test Webhook Event
    • Update Webhook Endpoint
    • Delete Webhook Endpoint
  • Zap Sites
    • Get Zap Site
    • Create Zap Site
    • Regenerate Zap Site
    • Deploy Zap Site
    • Scan Zap Site Destination
    • Update Zap Site
  • Zapwarm
    • List mailboxes eligible for warmup
    • Get the Zapwarm quote for selected mailboxes
    • Start Zapwarm on selected mailboxes
    • Turn off Zapwarm on selected mailboxes
    • Edit Zapwarm settings
    • Get zapwarm score
  • ZapPulse
    • Get ZapPulse Overview
    • Get ZapPulse Insights
    • List ZapPulse Mailboxes
    • Get ZapPulse Mailbox Report
    • Create ZapPulse Report Share Link
  1. Subscriptions and Workspaces

List Workspaces

GET
https://api.zapmail.ai/api/v3/workspaces
Lists the workspaces the account owns or has joined, with domain and mailbox counts and the billing details of each.
The workspace selected by x-workspace-key (the primary workspace by default) is returned as currentWorkspace and left out of workspaces, so a page can hold fewer items than limit.
role is the caller's role in each workspace.
Per-workspace counts are returned as numeric strings; top-level totals are numbers.
totalSearchedCount and totalPages are based on all workspaces, not on contains.
Related: Create Workspace, Update Workspace, List Workspace Members.

Request

Query Params

Header Params

Responses

🟢200Success
application/json
Success
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠403Forbidden
🟠429TooManyRequests
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/v3/workspaces' \
--header 'x-auth-zapmail;'
Response Response Example
200 - Success
{
    "status": 200,
    "message": "Workspaces fetched successfully",
    "data": {
        "totalSearchedCount": 2,
        "currentPage": 1,
        "nextPage": 2,
        "totalPages": 1,
        "totalWorkspacesCount": 2,
        "totalDomainsCountGoogle": 8,
        "totalDomainsCountMicrosoft": 0,
        "totalPurchasedMailboxesCountGoogle": 25,
        "totalPurchasedMailboxesCountMicrosoft": 0,
        "currentWorkspace": {
            "id": "5d0f3b52-8c1e-4a8e-9f67-2b1c7e0a4d11",
            "name": "Acme Outreach",
            "user_id": "c1f4a7d2-3b5e-4c6a-8d9f-0a1b2c3d4e5f",
            "domainCountGoogle": "6",
            "domainCountMicrosoft": "0",
            "assignedMailboxesCountGoogle": "14",
            "assignedMailboxesCountMicrosoft": "0",
            "totalMailboxesPurchasedGoogle": "20",
            "totalMailboxesPurchasedMicrosoft": "0",
            "activeMailboxCountGoogle": "12",
            "activeMailboxCountMicrosoft": "0",
            "billingDetails": {
                "id": "0b6d2f6e-7a43-4f0b-9a70-5e6c1b2d3f40",
                "userId": "c1f4a7d2-3b5e-4c6a-8d9f-0a1b2c3d4e5f",
                "workspaceId": "5d0f3b52-8c1e-4a8e-9f67-2b1c7e0a4d11",
                "company": "Acme Inc.",
                "firstName": "Jane",
                "lastName": "Doe",
                "addressLineOne": "2207 Maple Avenue",
                "addressLineTwo": "Suite 500",
                "addressLineThree": null,
                "city": "Dallas",
                "state": "Texas",
                "country": "US",
                "postalCode": "75201",
                "phoneCc": "1",
                "phone": "2149876543",
                "languagePreference": "en"
            },
            "role": "OWNER"
        },
        "workspaces": [
            {
                "id": "9a4e5c10-6b7d-4e21-8f33-1c2d3e4f5a6b",
                "name": "Acme Sales",
                "user_id": "c1f4a7d2-3b5e-4c6a-8d9f-0a1b2c3d4e5f",
                "domainCountGoogle": "2",
                "domainCountMicrosoft": "0",
                "assignedMailboxesCountGoogle": "4",
                "assignedMailboxesCountMicrosoft": "0",
                "totalMailboxesPurchasedGoogle": "5",
                "totalMailboxesPurchasedMicrosoft": "0",
                "activeMailboxCountGoogle": "4",
                "activeMailboxCountMicrosoft": "0",
                "billingDetails": null,
                "role": "ADMIN"
            }
        ]
    }
}
Previous
List Workspace Invitations
Next
List Subscriptions
Built with