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

# List your email sending domains

> The email domains Flow has set up for your account's emails, with the DKIM and Return-Path records to create and whether each is verified. Emails are only ever sent from a verified domain: a sender address may be on any of these, and is used once its domain is verified. Also answers the verified domain an unset address uses, and Flow's fallback address. While none is verified, each email comes from its own standard address in your name (the email list says which). Read-only: ask Flow support to add or remove one.



## OpenAPI

````yaml /api-reference/specs/administration.json get /customer/branding/sending-domains
openapi: 3.0.1
info:
  title: Administration API
  description: >-
    Manage your Flow Payroll account: the organisations it owns, the people who
    can sign in to it, the API tokens it holds, its brand, and a feed of recent
    administration activity. Every resource is scoped to the account your
    credentials belong to, so no request ever names a customer and the
    `X-Org-Id` header is not used.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/administration
security:
  - X-Auth-Token: []
tags:
  - name: Customer
    description: >-
      Your account: the customer every other resource on this API belongs to.
      Read it and rename it.
  - name: Organisations
    description: >-
      The organisations your account owns: list them with headcounts and your
      access to each, get one in full, and add one or several at a time.
  - name: Users
    description: >-
      The people who can sign in to your account: list, invite (one or many),
      resend invitations, and manage each person's direct grants and
      account-wide access.
  - name: API tokens
    description: >-
      The client credentials your integrations authenticate with: create (the
      secret is shown once), rename, rotate, revoke, and manage which
      organisations each token reaches.
  - name: Activity
    description: Recent administration actions in your account, newest first.
paths:
  /customer/branding/sending-domains:
    get:
      tags:
        - Branding
      summary: List your email sending domains
      description: >-
        The email domains Flow has set up for your account's emails, with the
        DKIM and Return-Path records to create and whether each is verified.
        Emails are only ever sent from a verified domain: a sender address may
        be on any of these, and is used once its domain is verified. Also
        answers the verified domain an unset address uses, and Flow's fallback
        address. While none is verified, each email comes from its own standard
        address in your name (the email list says which). Read-only: ask Flow
        support to add or remove one.
      operationId: ListBrandingSendingDomains
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendingDomainListResponseResponseBody'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    SendingDomainListResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/SendingDomainListResponseContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ObjectContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    SendingDomainListResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SendingDomainListResponse'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ObjectContentResponse:
      type: object
      properties:
        data:
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    SendingDomainListResponse:
      type: object
      properties:
        sendingDomains:
          type: array
          items:
            $ref: '#/components/schemas/SendingDomainResponse'
        standardFromAddress:
          type: string
          description: >-
            Flow's fallback address, for an email with no standard address of
            its own. While the account has no verified domain

            each email comes from its own standard address (notification's email
            list says which), in the account's name.
        firstVerifiedDomain:
          type: string
          description: >-
            The verified domain an unset sender address uses, as `noreply@` it;
            null while none is verified.
          nullable: true
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
    SendingDomainResponse:
      type: object
      properties:
        domain:
          type: string
        status:
          enum:
            - AwaitingDns
            - Verified
            - Failed
          type: string
          description: >-
            Where a sending domain is in its verification with the email
            provider.
        failureReason:
          type: string
          description: The email provider's own words, or null.
          nullable: true
        dkimVerified:
          type: boolean
        returnPathVerified:
          type: boolean
        dmarcFound:
          type: boolean
          description: >-
            Whether a DMARC record exists for the domain. Large mailbox
            providers require at least `p=none`;

            Flow never sets it, it only warns. Null when it could not be
            checked.
          nullable: true
        dnsRecords:
          type: array
          items:
            $ref: '#/components/schemas/DnsRecordResponse'
        nextStep:
          type: string
          description: Plain-English next step for whoever is looking at it.
        createdDate:
          type: string
        createdBy:
          type: string
        updatedDate:
          type: string
        updatedBy:
          type: string
      additionalProperties: false
      description: >-
        An email domain the account's emails can be sent from once verified. Set
        up by Flow on request.
    DnsRecordResponse:
      type: object
      properties:
        type:
          type: string
          description: >-
            `CNAME`, `TXT`, `ALIAS`, or `HTTP-REDIRECT` for a certificate token
            served from
                        the customer's existing site (no-downtime set-up).
        name:
          type: string
          description: The full record name, e.g. `payroll.acme.example`.
        value:
          type: string
        purpose:
          enum:
            - Routing
            - CertificateValidation
            - Dkim
            - ReturnPath
          type: string
          description: What a DNS record the customer must create is for.
      additionalProperties: false
      description: One DNS record the customer must create at their DNS provider.
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header

````

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