Get Screenshot Schedule API

Overview

Get Schedule

The Snapshot Get Schedule API lets you retrieve the complete configuration of an existing screenshot schedule using its schedule ID. The response includes the schedule name, description, status, scheduling configuration, next and previous run information, and all screenshot items associated with the schedule. Each item can include its target URL, viewport settings, full-page capture configuration, image format, quality, wait conditions, and extraction options. Use this endpoint when your application needs to view, inspect, or load an existing scheduled screenshot configuration for management 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",
      "responseType": "json",
      "quality": 100,
      "delay": 0,
      "waitUntil": "page_loaded",
      "waitUntilTimeout": 15,
      "waitFor": null,
      "crop": null,
      "element": null,
      "thumbnailWidth": null,
      "userAgent": null,
      "acceptLanguage": null,
      "extractHtml": true,
      "extractText": true,
      "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[].responseType	enum	Scheduled captures use json.
items[].quality	integer \| null	JPEG quality (0-100).
items[].delay	number \| null	Capture delay in seconds.
items[].waitUntil	enum \| null	dom_loaded, page_loaded, network_idle.
items[].waitUntilTimeout	number \| null	wait_until timeout in seconds.
items[].waitFor	string \| null	CSS selector wait target.
items[].crop	string \| null	Crop rectangle left,top,width,height.
items[].element	string \| null	Element selector target.
items[].thumbnailWidth	integer \| null	Thumbnail width.
items[].userAgent	string \| null	Custom user-agent.
items[].acceptLanguage	string \| null	Custom accept-language.
items[].extractHtml	boolean	Extract HTML enabled state.
items[].extractText	boolean	Extract text enabled state.
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.