Snapshot | Website Screenshot API

Overview

Get Schedule

Returns one schedule and all configured items by schedule ID. Use this to load full schedule details for viewing or editing.

Endpoint

GEThttps://snapshot-api.mindiqglobal.com/api/v1/schedules/{id}

Path Parameters

Name	Required	Type	Description
id	Yes	integer	Schedule ID.

Success Response

{
  "id": 21,
  "name": "Daily Homepage Check",
  "description": "Track homepage changes",
  "status": "ACTIVE",
  "schedule": {
    "type": "INTERVAL",
    "firstRunAt": "2026-08-07T09:00:00Z",
    "intervalValue": 1,
    "intervalUnit": "DAYS",
    "cronExpression": null
  },
  "nextRunAt": "2026-08-07T09:00:00Z",
  "lastRunAt": null,
  "items": [
    {
      "id": 44,
      "url": "https://example.com",
      "width": 1920,
      "height": 1080,
      "fullPage": true,
      "format": "png",
      "createdAt": "2026-08-06T10:00:00Z",
      "updatedAt": "2026-08-06T10:00:00Z"
    }
  ],
  "createdAt": "2026-08-06T10:00:00Z",
  "updatedAt": "2026-08-06T10:00:00Z"
}

Response Body Parameters

Name	Type	Description
id	integer	Schedule ID.
name	string	Schedule name.
description	string \| null	Schedule description.
status	enum	Schedule status, Possible values: ACTIVE, COMPLETED
schedule	object	Schedule timing configuration.
schedule.type	enum	Possible values: ONCE, INTERVAL, CRON.
schedule.firstRunAt	datetime \| null	First run datetime in ISO-8601 format.
schedule.intervalValue	integer \| null	Interval value for interval schedules.
schedule.intervalUnit	enum \| null	Possible values: MINUTES, HOURS, DAYS, WEEKS, MONTHS.
schedule.cronExpression	string \| null	Cron expression for cron schedules.
nextRunAt	datetime \| null	Next run datetime in ISO-8601 format.
lastRunAt	datetime \| null	Last run datetime in ISO-8601 format.
items	array	Schedule items.
items[].id	integer	Schedule item ID.
items[].url	string	Target URL.
items[].width	integer \| null	Viewport width.
items[].height	integer \| null	Viewport height.
items[].fullPage	boolean	Full page flag. Possible values: true, false.
items[].format	enum	Possible values: png, jpeg.
items[].createdAt	datetime	Item creation datetime in ISO-8601 format.
items[].updatedAt	datetime	Item update datetime in ISO-8601 format.
createdAt	datetime	Schedule creation datetime in ISO-8601 format.
updatedAt	datetime	Schedule update datetime in ISO-8601 format.