> ## 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 web addresses

> The web addresses Flow has set up for your app, with their status and the exact DNS record to create. Read-only: ask Flow support to add or remove one.



## OpenAPI

````yaml /api-reference/specs/administration.json get /customer/branding/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/domains:
    get:
      tags:
        - Branding
      summary: List your web addresses
      description: >-
        The web addresses Flow has set up for your app, with their status and
        the exact DNS record to create. Read-only: ask Flow support to add or
        remove one.
      operationId: ListBrandingDomains
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerDomainListResponseResponseBody'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    PartnerDomainListResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/PartnerDomainListResponseContentResponse'
        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
    PartnerDomainListResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PartnerDomainListResponse'
        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
    PartnerDomainListResponse:
      type: object
      properties:
        domains:
          type: array
          items:
            $ref: '#/components/schemas/PartnerDomainResponse'
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
    PartnerDomainResponse:
      type: object
      properties:
        hostname:
          type: string
          description: Lowercase, IDNA (punycode) form.
        environment:
          enum:
            - Sandbox
            - Production
          type: string
          description: >-
            Which Flow environment a partner domain serves. Production hostnames
            only in prod.
        certificateMode:
          enum:
            - FlowManaged
            - FlowManagedNoDowntime
            - CustomerProvided
          type: string
          description: Who issues and renews the partner domain's certificate.
        status:
          enum:
            - AwaitingDns
            - Validating
            - Active
            - Failed
            - Removing
            - Removed
            - Lapsed
          type: string
          description: Where a partner domain is in its set-up.
        failureReason:
          enum:
            - DnsNotPointingAtUs
            - CaaRecordBlocksCertificate
            - CertificateValidationTimedOut
            - DomainInUseElsewhere
            - ApexNeedsAliasOrFlattening
            - DnsNoLongerPointsAtUs
            - CertificateNoLongerValid
            - EdgeNoLongerServing
          type: string
          description: Set only when Status is `Failed`.
          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: A web address the account's app is served on. 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.