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

# List organization custom domains

> List the custom domains of every environment of the organization. Only organization admins can call it.
Each result is one domain name of one environment, with every route that serves it: a domain shared by several services of an environment is a single result.
Results are sorted by project name, environment name, environment id, then domain. A page never splits a domain.




## OpenAPI

````yaml /api-reference/openapi.yaml get /organization/{organizationId}/customDomain
openapi: 3.0.0
info:
  version: 1.0.4
  title: Qovery API
  description: >
    - Qovery is the fastest way to deploy your full-stack apps on any Cloud
    provider.

    - ℹ️ The API is stable and still in development.
  contact:
    name: Qovery Product Team
    url: https://www.qovery.com
    email: support+api+documentation@qovery.com
  x-logo:
    url: https://console.qovery.com/assets/logos/logo-white.svg
    altText: Qovery
servers:
  - url: https://api.qovery.com
security:
  - bearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Account
  - name: Account Info
  - name: IPs
  - name: Alert Receivers
  - name: Alert Rules
  - name: Admin
  - name: ArgoCD
  - name: Agentic Workflows
  - name: Application
  - name: Application Actions
  - name: Application Build Analysis
  - name: Application Configuration
  - name: Application Database
  - name: Application Deployment Restriction
  - name: Application Deployment History
  - name: Application Environment Variable
  - name: Application Logs
  - name: Application Main Calls
  - name: Application Secret
  - name: Application Annotations Group
  - name: Applications
  - name: AutoscalingPolicy
  - name: Container
  - name: Container Actions
  - name: Container Configuration
  - name: Container Database
  - name: Container Deployment History
  - name: Container Environment Variable
  - name: Container Logs
  - name: Container Main Calls
  - name: Container Registry
  - name: Container Secret
  - name: Container Annotations Group
  - name: Containers
  - name: Deployment Stage Main Calls
  - name: Job
  - name: Job Actions
  - name: Job Build Analysis
  - name: Job Configuration
  - name: Job Database
  - name: Job Deployment Restriction
  - name: Job Deployment History
  - name: Job Environment Variable
  - name: Job Logs
  - name: Job Main Calls
  - name: Job Registry
  - name: Job Secret
  - name: Job Annotations Group
  - name: Jobs
  - name: KedaTriggerAuthentication
  - name: Helm
  - name: Helm Actions
  - name: Helm Configuration
  - name: Helm Database
  - name: Helm Deployment Restriction
  - name: Helm Deployment History
  - name: Helm Logs
  - name: Helm Main Calls
  - name: Helm Repository
  - name: Helms
  - name: Backups
  - name: Billing
  - name: Blueprint Catalog
  - name: Cloud Provider
  - name: Cloud Provider Credentials
  - name: Clusters
  - name: Cluster Deployment History
  - name: Cluster Operator
  - name: Platform Configuration
  - name: Custom Domain
  - name: Container Custom Domain
  - name: LLM Providers
  - name: MCP Servers
  - name: Database
  - name: Database Actions
  - name: Database Application
  - name: Database Container
  - name: Database Deployment History
  - name: Database Main Calls
  - name: Database Annotations Group
  - name: Databases
  - name: Environment
  - name: Environment Actions
  - name: Environment Deployment History
  - name: Environment Deployment Rule
  - name: Environment Logs
  - name: Environment Main Calls
  - name: Environment Secret
  - name: Environment Variable
  - name: Environments
  - name: Git
  - name: Github App
  - name: Git repositories
  - name: Members
  - name: Organization
  - name: Organization Account Git Repositories
  - name: Organization Cluster Lock
  - name: Organization Main Calls
  - name: Organization Custom Role
  - name: Organization Custom Domain
  - name: Organization Event
  - name: Organization Api Token
  - name: Organization Policy Api Token
  - name: Organization Webhook
  - name: Organization Annotations Group
  - name: Organization Labels Group
  - name: Organization Enterprise Connection
  - name: Project
  - name: Project Deployment Rule
  - name: Project Environment Variable
  - name: Project Main Calls
  - name: Project Secret
  - name: Projects
  - name: Referral & Rewards
  - name: Secret Manager Access
  - name: Terraforms
  - name: Terraform Main Calls
  - name: Terraform Resources
  - name: Terraform Deployment History
  - name: Terraform Deployment Restriction
  - name: Container Registries
  - name: Helm Repositories
  - name: User Sign Up
  - name: Variable Main Calls
  - name: Helm Custom Domain
  - name: Lifecycle Template Main Calls
  - name: Blueprint Main Calls
paths:
  /organization/{organizationId}/customDomain:
    get:
      tags:
        - Organization Custom Domain
      summary: List organization custom domains
      description: >
        List the custom domains of every environment of the organization. Only
        organization admins can call it.

        Each result is one domain name of one environment, with every route that
        serves it: a domain shared by several services of an environment is a
        single result.

        Results are sorted by project name, environment name, environment id,
        then domain. A page never splits a domain.
      operationId: listOrganizationCustomDomain
      parameters:
        - $ref: '#/components/parameters/organizationId'
        - in: query
          name: projectId
          description: >-
            Only list the domains of this project. A project of another
            organization gives an empty list.
          schema:
            type: string
            format: uuid
        - in: query
          name: environmentId
          description: >-
            Only list the domains of this environment. An environment of another
            organization gives an empty list.
          schema:
            type: string
            format: uuid
        - in: query
          name: search
          description: >-
            Only list the domains whose name contains this text, ignoring case.
            The text is trimmed and matched literally, with no wildcard. A blank
            value does not filter.
          schema:
            type: string
        - in: query
          name: page
          description: >-
            The page to return, starting at 1. A page after the last one has no
            results.
          schema:
            type: integer
            minimum: 1
            default: 1
        - in: query
          name: pageSize
          description: The number of domains per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
      responses:
        '200':
          description: List organization custom domains
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/OrganizationCustomDomainPaginatedResponseList
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
components:
  parameters:
    organizationId:
      name: organizationId
      in: path
      description: Organization ID
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    OrganizationCustomDomainPaginatedResponseList:
      allOf:
        - $ref: '#/components/schemas/PaginationData'
        - type: object
          required:
            - results
            - total_count
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/OrganizationCustomDomainResponse'
            total_count:
              type: integer
              description: The number of domains matching the query, on all pages.
    PaginationData:
      type: object
      required:
        - page
        - page_size
      properties:
        page:
          type: number
          example: 1
        page_size:
          type: number
          example: 20
    OrganizationCustomDomainResponse:
      type: object
      description: >-
        One domain name of one environment, with every route that serves it. It
        has no id of its own; `environment_id` and `domain` identify it.
      required:
        - environment_id
        - domain
        - project
        - environment
        - routes
        - generate_certificate
        - use_cdn
      properties:
        environment_id:
          type: string
          format: uuid
          description: Id of the environment of the domain.
        domain:
          type: string
          description: The domain name.
          example: my.domain.tld
        project:
          $ref: '#/components/schemas/CustomDomainProjectResponse'
        environment:
          $ref: '#/components/schemas/CustomDomainEnvironmentResponse'
        routes:
          type: array
          description: The routes of the domain, one per service and path.
          items:
            $ref: '#/components/schemas/CustomDomainRouteResponse'
        generate_certificate:
          type: boolean
          description: >-
            Whether Qovery generates a certificate for the domain. `false` when
            a CDN or another party manages the certificate.
        use_cdn:
          type: boolean
          description: >-
            Whether the domain is behind a CDN. If `true`, Qovery only checks
            that the domain points to an IP; otherwise it checks that the domain
            resolves to the service load balancer.
    CustomDomainProjectResponse:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
          description: Id of the project.
        name:
          type: string
          description: Name of the project.
    CustomDomainEnvironmentResponse:
      type: object
      required:
        - id
        - name
        - routing_mode
      properties:
        id:
          type: string
          format: uuid
          description: Id of the environment.
        name:
          type: string
          description: Name of the environment.
        routing_mode:
          $ref: '#/components/schemas/EnvironmentRoutingModeEnum'
    CustomDomainRouteResponse:
      type: object
      description: >-
        Requests to the domain on `path` go to `port` of `service`. `port` is
        null when the service has no public port.
      required:
        - id
        - custom_domain_id
        - service
        - port
        - path
        - path_rewrite
      properties:
        id:
          type: string
          format: uuid
          description: Id of the route.
        custom_domain_id:
          type: string
          format: uuid
          description: >-
            Id of this domain in the custom domain API of the service
            (`/application|container|helm/{id}/customDomain/{customDomainId}`).
        service:
          $ref: '#/components/schemas/CustomDomainServiceResponse'
        port:
          allOf:
            - $ref: '#/components/schemas/CustomDomainPortResponse'
          nullable: true
        path:
          type: string
          description: The path of the requests this route serves.
          example: /
        path_rewrite:
          type: string
          nullable: true
          description: >-
            The path that replaces `path` before the request reaches the
            service. Null when the path is not rewritten.
    EnvironmentRoutingModeEnum:
      type: string
      description: >
        How the environment routes its custom domains.

        * `PER_ROUTER_LISTENER_SET`: a domain belongs to one service and follows
        its default public port and path.

        * `PER_HOSTNAME_LISTENER_SET`: several services can share a domain, and
        each route chooses its port, path and path rewrite.
      enum:
        - PER_ROUTER_LISTENER_SET
        - PER_HOSTNAME_LISTENER_SET
      example: PER_HOSTNAME_LISTENER_SET
    CustomDomainServiceResponse:
      type: object
      required:
        - id
        - type
        - name
      properties:
        id:
          type: string
          format: uuid
          description: Id of the service.
        type:
          allOf:
            - $ref: '#/components/schemas/ServiceTypeEnum'
          description: >-
            Type of the service. Only `APPLICATION`, `CONTAINER` and `HELM`
            services have custom domains.
        name:
          type: string
          description: Name of the service.
    CustomDomainPortResponse:
      type: object
      required:
        - id
        - name
        - internal_port
      properties:
        id:
          type: string
          format: uuid
          description: Id of the port.
        name:
          type: string
          description: Name of the port.
          example: p8080
        internal_port:
          type: integer
          description: The port the service listens on.
          example: 8080
    ServiceTypeEnum:
      type: string
      x-stoplight:
        id: d66063cd29913
      description: type of the service (application, database, job, ...)
      enum:
        - APPLICATION
        - DATABASE
        - CONTAINER
        - JOB
        - HELM
        - TERRAFORM
        - ARGOCD_APP
        - AGENTIC_WORKFLOW
  responses:
    '400':
      description: Bad request
    '401':
      description: Access token is missing or invalid
    '403':
      description: Access forbidden
    '404':
      description: Resource not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT tokens should be used with OIDC account (human to machine). JWT
        tokens used by the Qovery console to communicate with the API have a
        TTL. Curl Example ' curl https://console.qovery.com/organization -H
        "Authorization: Bearer $qovery_token" '
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token API are generated by Qovery to manage machine to machine
        interaction and do not have a TTL. Curl Example ' curl
        https://console.qovery.com/organization -H "Authorization: Token
        $qovery_token" '

````

## Related topics

- [List organization custom roles](https://www.qovery.com/docs/api-reference/organization-custom-role/list-organization-custom-roles.md)
- [List helm custom domains](https://www.qovery.com/docs/api-reference/helm-custom-domain/list-helm-custom-domains.md)
- [List application custom domains](https://www.qovery.com/docs/api-reference/application-custom-domain/list-application-custom-domains.md)
- [List container custom domains](https://www.qovery.com/docs/api-reference/container-custom-domain/list-container-custom-domains.md)
- [List organization LLM providers](https://www.qovery.com/docs/api-reference/llm-providers/list-organization-llm-providers.md)


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