Zapmail
v1
  • latest
  • v1
  1. workspaces
Zapmail
v1
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
      POST
    • Add third party account details
      POST
    • Update third party account details
      POST
  • subscriptions
    • Get all subscriptions
      GET
    • Cancel subscription
      POST
    • Upgrade existing subscription
      POST
  • domains
    • Retrieve All Domains
      GET
    • List Assignable Domains
      GET
    • Add DMARC record
      POST
    • Add Domain forwarding
      POST
    • Get Name servers to connect domain
      POST
    • Verify Name Server Propagation
      POST
    • Connect Domain with Zapmail
      POST
    • Enable email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Enable catch all emails
      POST
    • Remove catch all emails
      DELETE
    • Check DNS records
      POST
    • Remove unused domains
      DELETE
    • Get available domains for registration
      POST
    • Get domains purchase payment link
      POST
  1. workspaces

Retrieve all workspaces

GET
/v1/workspace/list
This endpoint allows you to get user workspaces.

Request

Header Params
x-auth-zapmail
string 
required
Example:
{{x-auth-zapmail}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zapmail.ai/api/v1/workspace/list' \
--header 'x-auth-zapmail: '

Responses

🟢200Success
application/json
Body
object {0}
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-01-30 13:13:12
Previous
Retrieve User Details
Next
Create new workspace
Built with