Zapmail
latest
  • latest
  • v1
  1. domains
Zapmail
latest
  • 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
    • Update Billing Details
      PUT
  • 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
    • Get Authenticator code
      GET
  • payments & wallet
    • Add balance to wallet
    • Get wallet balance
    • Enable auto recharge
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
  • 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
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  1. domains

List Assignable Domains

GET
/v2/domains/assignable

List of Domains for Mailbox Assignment#

This endpoint provides a list of domains to which you can assign mailboxes.

Query Parameters#

contains#

Type: string
Description: A search filter to return domains that match the specified criteria. The value can be any string, and only domains containing this string will be returned.
Example:
contains=example

page#

Type: number
Description: The page number for paginating through results. This allows you to retrieve results in multiple pages when dealing with large datasets.
Example:
page=2

Notes#

The contains parameter is optional and can be omitted if no filtering is needed.
The page parameter is used to retrieve paginated results, allowing you to navigate through different sets of domains.

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/v2/domains/assignable' \
--header 'x-auth-zapmail: '

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Previous
Retrieve All Domains
Next
Add DMARC record
Built with