InboxKit
  1. Domains
InboxKit
  • Introduction
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      GET
    • List assignable domains
      GET
    • Set DMARC policy
      POST
    • Remove DMARC policy
      DELETE
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
  • Mailboxes
    • List mailboxes
      GET
    • Show mailbox credentials
      GET
    • Get mailbox details
      GET
    • Buy mailboxes
      POST
    • Check mailbox status
      POST
    • Cancel mailboxes
      POST
    • Update mailbox
      POST
    • Update mailbox profile picture
      POST
    • Generate TOTP
      GET
    • Change username
      POST
    • Change password
      POST
    • Check mailbox availability
      GET
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  1. Domains

List assignable domains

GET
https://api.inboxkit.com/v1/api/domains/assignable
Domains
Maintainer:Not configured
Get domains that can be assigned to mailboxes
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.inboxkit.com/v1/api/domains/assignable?page&limit&keyword&min_mailboxes&uids={{$string.uuid}}&uids={{$string.uuid}}' \
--header 'X-Workspace-Id;'
Response Response Example
{
    "error": false,
    "message": "Assignable domains retrieved successfully",
    "domains": [
        {
            "_id": "string",
            "name": "example.com",
            "assigned_mailboxes": 0
        }
    ],
    "total": 0,
    "pages": 0,
    "current_page": "string",
    "limit": "string"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
page
integer 
optional
Page number for pagination
>= 1
Default:
1
limit
integer 
optional
Number of items per page
>= 1<= 100
Default:
10
keyword
string 
optional
Search keyword for filtering domains
min_mailboxes
integer 
optional
Minimum number of available mailboxes
>= 1
Default:
5
uids
array[string]
optional
Example:
["{{$string.uuid}}","{{$string.uuid}}"]
Header Params
X-Workspace-Id
string <uuid>
required
Workspace identifier

Responses

🟢200OK
application/json
Assignable domains retrieved successfully
Body
error
boolean 
optional
Example:
false
message
string 
optional
Example:
Assignable domains retrieved successfully
domains
array [object {3}] 
optional
_id
string 
optional
name
string 
optional
Example:
example.com
assigned_mailboxes
integer 
optional
Number of assigned mailboxes
total
integer 
optional
Total number of domains
pages
integer 
optional
Total number of pages
current_page
string 
optional
Current page number
limit
string 
optional
Items per page
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Modified at 2025-06-20 07:54:53
Previous
List domains
Next
Set DMARC policy
Built with