Overview
List Schedules
The Snapshot List Schedules API lets you retrieve a paginated list of screenshot schedules configured for your account. Each schedule includes key information such as its ID, name, status, next scheduled run, and last update time. Pagination and sorting options make it possible to efficiently retrieve and manage a large number of scheduled screenshot jobs. Use this endpoint when your application needs to display, monitor, or manage existing screenshot schedules and their current execution state.
Endpoint
GET
https://snapshot-api.mindiqglobal.com/api/v1/schedulesQuery Parameters
| Name | Required | Type | Default | Description |
|---|---|---|---|---|
| page | No | integer | 0 | Zero-based page index. |
| size | No | integer | 20 | Number of records per page. |
| sort | No | string | updatedAt,desc | Sorting 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
| Name | Type | Description |
|---|---|---|
| content | array | Schedule records. |
| content[].id | integer | Schedule ID. |
| content[].name | string | Schedule name. |
| content[].status | enum | Schedule status, Possible values: ACTIVE, COMPLETED |
| content[].nextRunAt | datetime | null | Next run datetime in ISO-8601 format. |
| content[].updatedAt | datetime | Last update datetime in ISO-8601 format. |
| number | integer | Current page index. |
| size | integer | Page size. |
| totalElements | integer | Total number of records. |
| totalPages | integer | Total number of pages. |