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

# List subdomains

> Lists all custom subdomains for the workspace associated with the Management API key.

Returns a compact representation of each subdomain, without DNS records. Use [Get subdomain](/reference/subdomainscontroller_findone) to retrieve the DNS records and full details for a single subdomain.

Filter by `status` to narrow the results, and use the `cursor` and `limit` parameters to page through them. See [Pagination](/reference/management-api-pagination) for details.

Note: Does not support `Legacy` subdomains. Migrate old certificates via the Dashboard to manage them via API.


## OpenAPI

````yaml reference/management-api_2025-11-20.json GET /subdomains
openapi: 3.0.0
info:
  title: Management API
  description: >-
    Managment API allows you to manage your Fingerprint account and applications
    programmatically from a server environment.
  version: '2025-11-20'
  contact: {}
servers:
  - url: https://management-api.fpjs.io
security:
  - Management-API-key: []
tags: []
paths:
  /subdomains:
    get:
      tags:
        - subdomains
      summary: List subdomains
      description: >-
        Lists all custom subdomains for the workspace associated with the
        Management API key.
      operationId: SubdomainsController_findAll
      parameters:
        - name: status
          required: false
          in: query
          description: Filter by subdomain status
          schema:
            enum:
              - pending
              - active
              - timed_out
              - failed
            type: string
        - name: cursor
          required: false
          in: query
          description: >-
            Cursor token used for pagination. Response will contain items
            appearing after the given cursor.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Sets the maximum number of items contained in a single page.
          schema:
            minimum: 0
            maximum: 101
            default: 10
            type: number
        - name: X-API-Version
          in: header
          description: Management API version.
          example: '2025-11-20'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: List of subdomains matching the given query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubdomainsPaginatedResponseDto'
        '401':
          description: 'Error: Invalid API key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiExceptionDto'
        '429':
          description: 'Error: API key has exceeded its rate limit.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiExceptionDto'
components:
  schemas:
    SubdomainsPaginatedResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubdomainListItemDto'
        metadata:
          $ref: '#/components/schemas/PaginationMetadataV2'
      required:
        - data
        - metadata
    ApiExceptionDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/BaseApiExceptionDto'
      required:
        - error
    SubdomainListItemDto:
      type: object
      properties:
        id:
          type: string
          description: Subdomain ID
          example: certv2_a1b2c3d4e5f6
        subdomain:
          type: string
          description: Subdomain hostname
          example: metrics.yourwebsite.com
        status:
          type: string
          enum:
            - pending
            - active
            - timed_out
            - failed
          description: >-
            Current subdomain status. `pending` = DNS/certificate setup in
            progress; `active` = live and serving traffic; `timed_out` = setup
            timed out (usually the required DNS records were never added) — safe
            to delete and recreate; `failed` = terminal failure.
        created_at:
          format: date-time
          type: string
          description: When the subdomain was created
          example: '2026-03-05T14:00:00.000Z'
        updated_at:
          format: date-time
          type: string
          description: When the subdomain was last updated
          example: '2026-03-05T14:35:00.000Z'
      required:
        - id
        - subdomain
        - status
        - created_at
        - updated_at
    PaginationMetadataV2:
      type: object
      properties:
        pagination:
          description: Object containing pagination metadata.
          allOf:
            - $ref: '#/components/schemas/PaginationDataV2'
      required:
        - pagination
    BaseApiExceptionDto:
      type: object
      properties:
        message:
          type: string
          description: Verbal description of the error.
        code:
          type: string
          description: Error code.
      required:
        - message
        - code
    PaginationDataV2:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: Cursor token to be used to get the next page of results.
          example: eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI
        prev_cursor:
          type: string
          nullable: true
          description: Cursor token used to get the previous page of results.
          example: null
      required:
        - next_cursor
        - prev_cursor
  securitySchemes:
    Management-API-key:
      scheme: bearer
      bearerFormat: JWT
      type: http

````