API Reference

Overview

List Schedules

Retrieves a paginated list of all configured screenshot schedules. Use this endpoint to view and manage scheduled screenshot jobs, including their execution status, schedule configuration, creation date, and other associated metadata. This endpoint supports pagination for efficient retrieval of large collections of schedules.

Endpoint

GEThttps://snapshot-api.mindiqglobal.com/api/v1/schedules

Query Parameters

NameRequiredTypeDefaultDescription
pageNointeger0Zero-based page index.
sizeNointeger20Number of records per page.
sortNostringupdatedAt,descSorting format: field,direction.

Success Response

{
  "content": [
    {
      "id": 21,
      "name": "Daily Homepage Check",
      "status": "ACTIVE",
      "nextRunAt": "2026-08-07T09:00:00Z",
      "updatedAt": "2026-08-06T10:00:00Z"
    }
  ],
  "number": 0,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1
}

Response Body Parameters

NameTypeDescription
contentarraySchedule records.
content[].idintegerSchedule ID.
content[].namestringSchedule name.
content[].statusenumSchedule status, Possible values: ACTIVE, COMPLETED
content[].nextRunAtdatetime | nullNext run datetime in ISO-8601 format.
content[].updatedAtdatetimeLast update datetime in ISO-8601 format.
numberintegerCurrent page index.
sizeintegerPage size.
totalElementsintegerTotal number of records.
totalPagesintegerTotal number of pages.