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

# List snoozes

> Returns a paginated list of snoozes for the scoped project, with optional filtering by environment and status.



## OpenAPI

````yaml /api-reference/openapi.generated.json get /api/snoozes
openapi: 3.1.0
info:
  title: Empirical API
  version: 1.0.0
  description: Programmatic access to Empirical test runs, snoozes, and more.
  contact:
    name: Empirical
    url: https://empirical.run
servers:
  - url: https://api.empirical.run
security:
  - Bearer: []
tags:
  - name: Snoozes
    description: Temporarily suppress known test failures for specific Playwright tests.
paths:
  /api/snoozes:
    get:
      tags:
        - Snoozes
      summary: List snoozes
      description: >-
        Returns a paginated list of snoozes for the scoped project, with
        optional filtering by environment and status.
      operationId: listSnoozes
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
            description: Page number (1-indexed).
          required: false
          description: Page number (1-indexed).
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: Items per page (max 100).
          required: false
          description: Items per page (max 100).
          name: per_page
          in: query
        - schema:
            type: integer
            minimum: 1
            description: Filter to snoozes scoped to this environment.
          required: false
          description: Filter to snoozes scoped to this environment.
          name: environment_id
          in: query
        - schema:
            type: string
            enum:
              - active
              - expired
              - all
            default: active
            description: Filter by snooze status.
          required: false
          description: Filter by snooze status.
          name: status
          in: query
      responses:
        '200':
          description: Paginated list of snoozes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnoozeListResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SnoozeListResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            snoozes:
              type: array
              items:
                $ref: '#/components/schemas/Snooze'
          required:
            - snoozes
          description: The page of snoozes.
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        data:
          nullable: true
          description: Always null for error responses.
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
          required:
            - message
          description: Error details.
      required:
        - data
        - error
    Snooze:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier for the snooze.
        test_ids:
          type: array
          items:
            type: string
          description: Array of Playwright test IDs (41-character hashes) that are snoozed.
        snooze_until:
          type: string
          description: >-
            ISO 8601 timestamp for when the snooze expires. Active when in the
            future.
        description:
          type: string
          nullable: true
          description: Description of why the tests are snoozed.
        created_from_test_run_id:
          type: number
          nullable: true
          description: >-
            ID of the test run that triggered the snooze creation, if
            applicable.
        created_by:
          type: string
          nullable: true
          description: >-
            User ID of the creator. Set automatically for dashboard users;
            `null` for API-created snoozes.
        created_at:
          type: string
          description: ISO 8601 timestamp of when the snooze was created.
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the snooze was last updated.
        scoped_to_environment_id:
          type: number
          nullable: true
          description: >-
            Environment ID this snooze is scoped to. `null` if it applies to all
            environments.
      required:
        - id
        - test_ids
        - snooze_until
        - description
        - created_from_test_run_id
        - created_by
        - created_at
        - updated_at
        - scoped_to_environment_id
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page (1-indexed).
        per_page:
          type: integer
          description: Items per page.
        total:
          type: integer
          description: Total number of items.
        total_pages:
          type: integer
          description: Total number of pages.
      required:
        - page
        - per_page
        - total
        - total_pages
      description: Pagination metadata.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````