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

# List domains

> List hostnames under one apex (Postgres; not Attack Surface). Ordered by apex then FQDN. Requires apexDomain. Offset pagination via page + limit.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/orgs/{orgSlug}/domains
openapi: 3.0.3
info:
  title: Tolmo API
  version: 1.0.0
  description: >-
    The Tolmo REST API. Every endpoint is scoped to one organization and
    authenticated with an API token.
servers:
  - url: https://api.tolmo.com
    description: Production
security:
  - bearerAuth: []
paths:
  /api/v1/orgs/{orgSlug}/domains:
    get:
      tags:
        - domains
      summary: List domains
      description: >-
        List hostnames under one apex (Postgres; not Attack Surface). Ordered by
        apex then FQDN. Requires apexDomain. Offset pagination via page + limit.
      operationId: apiListDomains
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 512
          in: query
          name: q
          required: false
        - schema:
            type: string
            enum:
              - current
              - stale
              - historical
          in: query
          name: lifecycleStatus
          required: false
        - schema:
            type: string
            enum:
              - resolved
              - unresolved
              - error
              - not_checked
          in: query
          name: dnsStatus
          required: false
        - schema:
            type: string
            enum:
              - reachable
              - unreachable
              - blocked
              - not_checked
          in: query
          name: webStatus
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 128
          in: query
          name: source
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 1024
          in: query
          name: labels
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: offensiveAuthorized
          required: false
        - schema:
            type: integer
            minimum: 1
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 253
          in: query
          name: apexDomain
          required: true
        - schema:
            type: string
          in: path
          name: orgSlug
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                  limit:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                  total:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  totalPages:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        fqdn:
                          type: string
                        apexDomain:
                          type: string
                        lifecycleStatus:
                          type: string
                          enum:
                            - current
                            - stale
                            - historical
                        dnsStatus:
                          type: string
                          enum:
                            - resolved
                            - unresolved
                            - error
                            - not_checked
                        webStatus:
                          type: string
                          enum:
                            - reachable
                            - unreachable
                            - blocked
                            - not_checked
                        addresses:
                          type: array
                          items:
                            type: string
                        cname:
                          nullable: true
                          type: string
                        preferredUrl:
                          nullable: true
                          type: string
                        httpStatus:
                          nullable: true
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        redirectUrl:
                          nullable: true
                          type: string
                        title:
                          nullable: true
                          type: string
                        tlsNotAfter:
                          nullable: true
                          type: string
                        firstDiscoveredAt:
                          type: string
                        lastDiscoveredAt:
                          type: string
                        lastCheckedAt:
                          type: string
                        lastResolvedAt:
                          nullable: true
                          type: string
                        lastHttpSeenAt:
                          nullable: true
                          type: string
                        staleSince:
                          nullable: true
                          type: string
                        sources:
                          type: array
                          items:
                            type: string
                        environment:
                          nullable: true
                          type: string
                          enum:
                            - production
                            - staging
                        environmentSource:
                          nullable: true
                          type: string
                          enum:
                            - override
                            - hostname
                            - aws_account
                            - sibling
                            - target_tag
                            - heroku_pipeline
                        environmentAuto:
                          nullable: true
                          type: string
                          enum:
                            - production
                            - staging
                        environmentOverride:
                          nullable: true
                          type: string
                          enum:
                            - production
                            - staging
                            - unlabeled
                        labels:
                          type: array
                          items:
                            type: string
                        offensiveAuthorizedAt:
                          nullable: true
                          type: string
                        offensiveAuthorizedBy:
                          nullable: true
                          type: string
                      required:
                        - id
                        - fqdn
                        - apexDomain
                        - lifecycleStatus
                        - dnsStatus
                        - webStatus
                        - addresses
                        - cname
                        - preferredUrl
                        - httpStatus
                        - redirectUrl
                        - title
                        - tlsNotAfter
                        - firstDiscoveredAt
                        - lastDiscoveredAt
                        - lastCheckedAt
                        - lastResolvedAt
                        - lastHttpSeenAt
                        - staleSince
                        - sources
                        - environment
                        - environmentSource
                        - environmentAuto
                        - environmentOverride
                        - labels
                        - offensiveAuthorizedAt
                        - offensiveAuthorizedBy
                      additionalProperties: false
                required:
                  - page
                  - limit
                  - total
                  - totalPages
                  - items
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
components:
  schemas:
    HttpError:
      type: object
      properties:
        statusCode:
          type: number
        code:
          type: string
        error:
          type: string
        message:
          type: string
      title: HttpError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Tolmo API token, sent as `Authorization: Bearer <token>`. Either a
        user token (`usr_tok.*`, minted by `tolmo auth login`, scoped to your
        own permissions) or an org API token created in the Tolmo app, for CI
        and automation.

````