List Domains

GET 
/api/domains

Get paginated list of domains for the current tenant.

Query Parameters:

• page: Page number (default: 1)
• page_size: Items per page (default: 20, max: 100)
• status: Filter by status (pending, verified, failed)
• search: Search term
• for_options: Return simplified format for dropdowns (default: false)
• data_for: Filter by data type - 'email' or 'domain'
• email_integration_id: Filter by email integration ID (for channel configuration)

Sample API Calls:

1. Get domains for dropdown (email configuration): GET /api/domains?for_options=true&data_for=email

2. Get all domains: GET /api/domains?data_for=domain

Response Format (for_options=false): { "domains": [...], "total_count": 1, "page": 1, "page_size": 20 }

Response Format (for_options=true): { "options": [ { "id": "uuid", "label": "example.com", "value": "uuid", "status": "verified", "disabled": false, "disabled_reason": null }, { "id": "uuid2", "label": "unverified.com", "value": "uuid2", "status": "unverified", "disabled": true, "disabled_reason": "Domain not verified. Please verify your domain." } ], "total": 2, "has_verified_domains": true, "verification_url": "/settings/saas-configurator/domain" }

Request​