Skip to main content
GET
/
api
/
snoozes
List Snoozes
curl --request GET \
  --url https://api.example.com/api/snoozes \
  --header 'Authorization: <authorization>'
{
  "data": {
    "snoozes": [
      {
        "id": 12,
        "project_id": 4,
        "test_ids": [
          "a30a6eba6312f6b87ea5-55e241fbe3f4b8ae61ee",
          "b41b7fca7423g7c98fb6-66f352gcf4g5c9bf72ff"
        ],
        "snooze_until": "2026-04-15T00:00:00.000Z",
        "description": "Flaky due to third-party API instability",
        "created_from_test_run_id": 456,
        "created_by": null,
        "created_at": "2026-03-15T10:30:00.000Z",
        "updated_at": "2026-03-15T10:30:00.000Z",
        "scoped_to_environment_id": null
      }
    ]
  },
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 3,
    "total_pages": 1
  }
}
Retrieves a paginated list of snoozes for a project with optional filtering by environment and active status.

​
Examples

​
Request

​
Authorization
string
required
Bearer token for authentication. Format: Bearer <your-api-key>
​
project_id
number
required
The project ID.
​
per_page
number
default:20
Maximum number of snoozes to return. Must be between 1 and 100.
​
page
number
default:1
Page number (1-indexed).
​
environment_id
number
Filter by environment ID.
​
status
string
default:"active"
Filter by status. Accepted values: active (default — returns snoozes where snooze_until is in the future), expired (returns snoozes where snooze_until is in the past), all (returns all snoozes).

​
Response

​
data.snoozes
array
List of snoozes matching the filters.
​
pagination
object
{
  "data": {
    "snoozes": [
      {
        "id": 12,
        "project_id": 4,
        "test_ids": [
          "a30a6eba6312f6b87ea5-55e241fbe3f4b8ae61ee",
          "b41b7fca7423g7c98fb6-66f352gcf4g5c9bf72ff"
        ],
        "snooze_until": "2026-04-15T00:00:00.000Z",
        "description": "Flaky due to third-party API instability",
        "created_from_test_run_id": 456,
        "created_by": null,
        "created_at": "2026-03-15T10:30:00.000Z",
        "updated_at": "2026-03-15T10:30:00.000Z",
        "scoped_to_environment_id": null
      }
    ]
  },
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 3,
    "total_pages": 1
  }
}

​
Basic list

curl -X GET \
  "https://dash.empirical.run/api/snoozes?project_id=4" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY"

​
Filter expired snoozes

curl -X GET \
  "https://dash.empirical.run/api/snoozes?project_id=4&status=expired" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY"

​
Filter by environment

curl -X GET \
  "https://dash.empirical.run/api/snoozes?project_id=4&environment_id=7" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY"

​
Pagination

curl -X GET \
  "https://dash.empirical.run/api/snoozes?project_id=4&per_page=10&page=2" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY"