> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coldsend.pro/llms.txt
> Use this file to discover all available pages before exploring further.

# List domains

> **List all domains in your workspace**

Retrieve a paginated list of custom domains configured for email sending.

## Domain Status Values

- **PENDING**: Initial state, waiting to start setup
- **DNS_CONFIGURING**: Setting up DNS infrastructure
- **DNS_PENDING**: Waiting for you to configure DNS records
- **SERVICES_CONFIGURING**: Setting up email services
- **ACTIVE**: Domain is ready to use
- **FAILED**: Setup failed - can retry

## Filtering Options

- **status**: Filter by domain status

## Pagination

- **page**: Page number (1-based)
- **limit**: Items per page (1-100, default 20)

## Example Usage

```python
import requests

response = requests.get(
    "https://api.coldsend.io/api/public/v1/domains?status=ACTIVE",
    headers={"X-API-Key": "your-api-key"}
)

print(response.json())
```



## OpenAPI

````yaml /public_openapi.json get /api/public/v1/domains
openapi: 3.0.3
info:
  title: ColdSend Public API
  description: >-
    Programmatic access to ColdSend for managing cold email campaigns and sender
    accounts.
  version: 1.0.0
  contact:
    name: ColdSend Support
    email: support@coldsend.pro
    url: https://coldsend.pro
servers:
  - url: https://api.coldsend.pro
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/public/v1/domains:
    get:
      tags:
        - Domains
      summary: List domains
      description: >-
        **List all domains in your workspace**


        Retrieve a paginated list of custom domains configured for email
        sending.


        ## Domain Status Values


        - **PENDING**: Initial state, waiting to start setup

        - **DNS_CONFIGURING**: Setting up DNS infrastructure

        - **DNS_PENDING**: Waiting for you to configure DNS records

        - **SERVICES_CONFIGURING**: Setting up email services

        - **ACTIVE**: Domain is ready to use

        - **FAILED**: Setup failed - can retry


        ## Filtering Options


        - **status**: Filter by domain status


        ## Pagination


        - **page**: Page number (1-based)

        - **limit**: Items per page (1-100, default 20)


        ## Example Usage


        ```python

        import requests


        response = requests.get(
            "https://api.coldsend.io/api/public/v1/domains?status=ACTIVE",
            headers={"X-API-Key": "your-api-key"}
        )


        print(response.json())

        ```
      operationId: list_domains_api_public_v1_domains_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 20
            title: Limit
          description: Items per page
        - name: status_filter
          in: query
          required: false
          schema:
            type: string
            nullable: true
            title: Status Filter
            description: Filter by status
          description: Filter by status
      responses:
        '200':
          description: Domains retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainListResponse'
        '401':
          description: Missing or invalid API key
        '403':
          description: Insufficient permissions - requires 'domains:read' scope
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DomainListResponse:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        message:
          type: string
          title: Message
          default: Domains retrieved successfully
        domains:
          items:
            $ref: '#/components/schemas/DomainListItem'
          type: array
          title: Domains
          description: List of domains
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
          description: Pagination information
      type: object
      required:
        - domains
        - pagination
      title: DomainListResponse
      description: Response for listing domains.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DomainListItem:
      properties:
        domain_id:
          type: string
          format: uuid
          title: Domain Id
          description: Domain ID
        domain_name:
          type: string
          title: Domain Name
          description: Domain name
        status:
          type: string
          title: Status
          description: Domain status
        stalwart_added:
          type: boolean
          title: Stalwart Added
          description: Whether added to Stalwart
        cloudflare_verified:
          type: boolean
          title: Cloudflare Verified
          description: Whether Cloudflare is verified
        max_inboxes:
          type: integer
          title: Max Inboxes
          description: Maximum inboxes allowed
        current_inboxes:
          type: integer
          title: Current Inboxes
          description: Current inbox count
        aggregate_health_score:
          type: number
          title: Aggregate Health Score
          description: >-
            Average health score of all inboxes on this domain (0-100). 100.0 if
            no inboxes.
        created_at:
          type: string
          title: Created At
          description: Creation timestamp
      type: object
      required:
        - domain_id
        - domain_name
        - status
        - stalwart_added
        - cloudflare_verified
        - max_inboxes
        - current_inboxes
        - aggregate_health_score
        - created_at
      title: DomainListItem
      description: Domain list item schema.
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        limit:
          type: integer
          title: Limit
        total:
          type: integer
          title: Total
        pages:
          type: integer
          title: Pages
        has_next:
          type: boolean
          title: Has Next
        has_prev:
          type: boolean
          title: Has Prev
      type: object
      required:
        - page
        - limit
        - total
        - pages
        - has_next
        - has_prev
      title: PaginationMeta
      description: Pagination metadata schema.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with format cs_live_xxx

````