- Zapmail Docs
- users
- workspaces
- billing
- mailbox
- payments & wallet
- export
- subscriptions
- domains
- Retrieve All Domains
- List Assignable Domains
- Add DMARC record
- Add Domain forwarding
- Get Name servers to connect domain
- Verify Name Server Propagation
- Connect Domain with Zapmail
- Enable email forwarding
- Remove email forwarding
- Enable catch all emails
- Remove catch all emails
- Check DNS records
- Remove unused domains
- Get available domains for registration
- Get domains purchase payment link
- dns
Retrieve all workspaces
GET
/v2/workspaces
Request
Query Params
page
string
required
Example:
1,2,3...
limit
string
required
Example:
10, 50, 100
contains
string
optional
Example:
tryzapmail.com
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/v2/workspaces?page=1,2,3...&limit=10, 50, 100&contains=tryzapmail.com' \
--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"
}
}
]
}