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

# List Domains

> Returns the domains connected to your account.

`ready_to_send` tells you whether `Send Email` accepts the domain right now. A domain that is still being set up, is blocked, or hasn't finished its initial warmup can't send yet, and `unavailable_reason` says why. Use `List Domain Emails` to get the email accounts that can send from a domain. Supports pagination with `limit` and `offset`.



## OpenAPI

````yaml /openapi.yml get /api/v2/domains/
openapi: 3.1.1
info:
  title: DeliverymanAI API
  version: 2.0.0
  description: >-
    API documentation for DeliverymanAI. Send emails, track their delivery and
    engagement, read replies, verify addresses, manage your suppression list and
    receive webhook events.


    **Strongly recommended:** leave 5 to 10 minutes between emails sent from the
    same domain. Sending many emails from one domain in a short time can hurt
    your domain and IP reputation.


    **Rate limits:** emails from one sending domain go out at least a minimum
    interval apart. If you send sooner, the email is queued and `Send Email`
    returns `202`. Each endpoint also caps how many requests your account can
    make per minute. Over the cap you get `429` with a `Retry-After` header.
    Treat these limits as an upper bound and keep to the gap recommended above.
servers:
  - url: https://api.deliveryman.ai
    description: Deliveryman API Server
security: []
paths:
  /api/v2/domains/:
    get:
      tags:
        - Domains
      summary: List Domains
      description: >-
        Returns the domains connected to your account.


        `ready_to_send` tells you whether `Send Email` accepts the domain right
        now. A domain that is still being set up, is blocked, or hasn't finished
        its initial warmup can't send yet, and `unavailable_reason` says why.
        Use `List Domain Emails` to get the email accounts that can send from a
        domain. Supports pagination with `limit` and `offset`.
      operationId: v2_list_domains
      parameters:
        - in: query
          name: limit
          schema:
            default: 20
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
          description: >-
            Maximum number of records to return. Must be between 1 and 100.
            Defaults to 20.
        - in: query
          name: offset
          schema:
            default: 0
            minimum: 0
            title: Offset
            type: integer
          description: >-
            Number of records to skip before returning results. For example, an
            offset of 0 starts at the most recent record, while an offset of 50
            starts at the 51st. Defaults to 0.
        - in: query
          name: workspace_id
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            default: null
            title: Workspace Id
          description: >-
            Only return domains in this workspace. Returns domains from all your
            workspaces when not set.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainsResponse'
          description: Success
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
          description: Workspace Not Found
        '500':
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: >-
            curl
            "https://api.deliveryman.ai/api/v2/domains/?limit=20&offset=0&workspace_id=12"
            \
              -H "X-Api-Key: YOUR_API_KEY"
components:
  schemas:
    ListDomainsResponse:
      type: object
      description: A page of connected domains.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
          description: Connected domains, newest first.
        total:
          type: integer
          minimum: 0
          description: Total number of domains matching the filter.
      required:
        - data
        - total
    MessageResponse:
      type: object
      description: A message describing the result of the request, or what went wrong.
      properties:
        message:
          type: string
          description: Human readable description of the result or error.
      required:
        - message
    Domain:
      type: object
      description: A domain connected to your account.
      properties:
        domain:
          type: string
          description: >-
            The connected domain. Pass it as `from` in `Send Email` to let one
            of its email accounts be picked for you.
        status:
          type: string
          description: >-
            Setup state of the domain. `active` and `warmup` domains can send;
            the rest are still being set up, being removed, or in an error
            state.
        ready_to_send:
          type: boolean
          description: >-
            Whether `Send Email` accepts this domain right now. False while it's
            being set up, blocked, or still in its initial warmup period.
        unavailable_reason:
          type:
            - string
            - 'null'
          description: Why the domain can't send, or null when it can.
        workspace_id:
          type: integer
          description: Workspace the domain belongs to.
      required:
        - domain
        - ready_to_send
        - status
        - unavailable_reason
        - workspace_id
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Your API key. In the dashboard, go to Integrations and open Deliveryman
        API Keys to create one.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.