Skip to content
Documentation/API reference
API · domains

List domains

GET /api/v2/domains

Authorization

emails:read or user session. Use a workspace-scoped bearer key or an authorized user session.

Parameters

All resource access is checked against the selected workspace and user permissions.

Request

Set INBOXIT_API_KEY in your server environment. The CLI can also use an authenticated user session.

Example
curl -X GET 'https://inboxit.wtf/api/v2/domains' \
  -H "Authorization: Bearer $INBOXIT_API_KEY"

CLI equivalent

Use INBOXIT_TOKEN for a scoped key, or inboxit login for a user session.

Example
inboxit domains list

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example
{
  "allowance": {
    "domain_limit": 1,
    "domains_used": 0,
    "can_add_domain": true
  },
  "domains": []
}

Behavior & errors

Allowance also includes plan entitlements. Domains contain id, name, status, checks, checked_at, created_at and records. Pending domains count toward the account limit. Example allowance is an excerpt. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.