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

# List status pages

> Every status page of the organization: subdomain, title, `public_url` (the active custom domain when there is one, else the subdomain URL), access mode, custom domain state and config identity. Not paginated.



## OpenAPI

````yaml api-reference/openapi.json GET /pages
openapi: 3.1.0
info:
  title: Observer API
  version: 1.0.0
  description: >-
    Public API for Observer: read services, metrics, SLOs and SLA statements;
    manage incidents, maintenance windows, manual metric status, config as code
    and Observer Agents. Bearer-auth via API keys (obs_pub_…), scoped per key.
    RFC 7807 problem-detail errors. Cursor pagination. Rate limits are per
    organization.
servers:
  - url: https://use.observer/api/v1
security:
  - bearerAuth: []
paths:
  /pages:
    get:
      tags:
        - pages
      summary: List status pages with their public URL
      description: >-
        Every status page of the organization: subdomain, title, `public_url`
        (the active custom domain when there is one, else the subdomain URL),
        access mode, custom domain state and config identity. Not paginated.
      operationId: listPages
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Page'
                  next_cursor:
                    type:
                      - string
                      - 'null'
        '401':
          description: >-
            `unauthenticated`: no bearer token was sent, or the key is invalid
            or revoked. `detail` distinguishes the two.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: >-
            `forbidden`: the key does not carry the scope this endpoint
            requires. `plan_does_not_permit_api`: the organization's plan does
            not include the public API.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: '`not_found`: not found. Cross-tenant ids return the same response.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            `rate_limited`: the organization's per-minute or daily request limit
            is used up (`limit.window` says which). Limits are per organization,
            shared by every key. The response carries `Retry-After` and
            `retry_after`, in seconds.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: '`internal_error`: an unhandled server error. Safe to retry.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth:
            - read:config
components:
  schemas:
    Page:
      type: object
      required:
        - id
        - title
        - subdomain
        - public_url
        - access_mode
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        subdomain:
          type: string
        public_url:
          type: string
          format: uri
          description: >-
            Where the page is served: the custom domain when it is active, else
            the subdomain URL.
        access_mode:
          type: string
          description: public, password, ip_allowlist, jwt or customer_scoped.
        layout:
          type: string
        timezone:
          type: string
        custom_domain:
          type:
            - object
            - 'null'
          description: The custom domain, when one is set up (in the console).
          properties:
            domain:
              type: string
            state:
              type: string
              description: >-
                Provisioning state; public_url uses the domain only when this is
                active.
            last_error:
              type:
                - string
                - 'null'
        config_key:
          type:
            - string
            - 'null'
          description: >-
            The page's key in config documents (null for one made in the console
            and never applied from config). Per-key DELETE takes this.
        managed_by:
          type: string
          enum:
            - config
            - console
          description: >-
            config: owned by config apply (prune and per-key delete may remove
            it). console: made in the console; config apply adopts it when a
            document names it.
        is_demo:
          type: boolean
        updated_at:
          type: string
          format: date-time
    Problem:
      type: object
      required:
        - type
        - title
        - status
      example:
        type: https://docs.use.observer/api/getting-started/errors#forbidden
        title: forbidden
        status: 403
        detail: 'missing scope: write:incidents'
      properties:
        type:
          type: string
          format: uri
          description: Errors reference URI with the title token as the fragment.
          example: https://docs.use.observer/api/getting-started/errors#forbidden
        title:
          type: string
          description: Stable error token. Branch on this, not on detail.
        status:
          type: integer
        detail:
          type: string
          description: Human-readable explanation. Wording may change.
        retry_after:
          type: integer
          description: >-
            429 only: seconds until the exhausted window resets (mirrors
            Retry-After).
        limit:
          type: object
          description: '429 only: which organization limit was hit.'
          properties:
            scope:
              type: string
              enum:
                - organization
            window:
              type: string
              enum:
                - minute
                - day
            max:
              type: integer
            plan:
              type: string
        errors:
          type: array
          description: >-
            Validation failures (config_invalid, invalid_customer_targeting):
            one entry per problem.
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
        warnings:
          type: array
          description: >-
            config_invalid only: the same non-fatal warnings a successful apply
            returns.
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
        unknown_customers:
          type: array
          description: >-
            unknown_customers only: the submitted values that matched no
            customer in your organization.
          items:
            type: string
        referenced_by:
          type: object
          description: >-
            in_use only: what depends on the object (slos, pages: lists of { id,
            config_key, name }; subscribers: a count).
        quota:
          type: object
          description: >-
            quota_exceeded / feature_locked on a create only: the plan limit
            that blocked it.
          properties:
            capability:
              type: string
            used:
              type:
                - integer
                - 'null'
            cap:
              type:
                - integer
                - 'null'
            plan:
              type:
                - string
                - 'null'
        upgrade:
          type: object
          description: >-
            Plan-limit problems only, when a higher plan lifts the limit: the
            smallest such plan and the pricing page.
          properties:
            plan:
              type: string
            label:
              type: string
            url:
              type: string
              format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: obs_pub_
      description: >-
        An organization API key (obs_pub_…) sent as `Authorization: Bearer
        <key>`. Each key carries scopes; an endpoint lists the scope it needs.

````

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