It’s simple to use: you only need to submit your access_key. The API will return the list of your scheduled tasks for your account.
Plan RequirementScheduled Tasks are available only on the Scale plan.
Upgrade your account via the Subscription / Dashboard section to unlock this feature.
Requests to this endpoint are not counted against your usage quota, but they are still subject to rate limiting. This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.
The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.
Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST and PATCH requests, you can include your access key in the request body as a JSON object.
You can also use the X-Access-Key header to pass your access key.
You can find your access key in your account dashboard.
Query parameters for the scheduled task without the access_key parameter.
The querystring can be URL-encoded.For example, url=https%3A%2F%2Fexample.com is the URL-encoded version of url=https://example.com.
Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.
Code
Type
Details
200
OK
The request was successful.
400
Bad Request
The request was rejected due to a missing or invalid parameter.
401
Unauthorized
The request was rejected due to an invalid access key.
402
Payment Required
Access denied due to an unpaid invoice.
404
Not Found
The requested resource was not found.
423
Locked
The request was denied due to insufficient quota.
429
Too Many Requests
The rate limit has been exceeded (too many requests per minute).
500
Internal server error
The request failed due to an internal server error.
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"ScreenshotMAX API","description":"ScreenshotMAX API documentation","colors":{"primary":"#3366FF","light":"#AE87FF","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/screenshotmax/T1xOqe1MKSP6l0-_/logo/logo-light.png?fit=max\u0026auto=format\u0026n=T1xOqe1MKSP6l0-_\u0026q=85\u0026s=4b3619eb6512d1558a324ac0cc879acc","dark":"https://mintcdn.com/screenshotmax/T1xOqe1MKSP6l0-_/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=T1xOqe1MKSP6l0-_\u0026q=85\u0026s=5e1058fb1d06142754e5c92419c338ec","href":"https://screenshotmax.com"},"favicon":"/favicon.svg","navbar":{"links":[{"label":"Home","href":"https://screenshotmax.com"},{"label":"Pricing","href":"https://screenshotmax.com/pricing"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.screenshotmax.com"}},"footer":{"socials":{"website":"https://screenshotmax.com","github":"https://github.com/screenshotmax"}},"seo":{"indexing":"all"},"styling":{"eyebrows":"section"},"integrations":{"gtm":{"tagId":"GTM-WX7ZQHCM"}},"contextual":{"options":["chatgpt"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"screenshotmax","hasAudioNarration":false,"actualSubdomain":"screenshotmax","customDomains":["docs.screenshotmax.com"],"gitSource":{"type":"github","owner":"hellobertrand","repo":"getstore-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e6af044dd579e9b57e2c","collectionId":"a05d77eb-5a97-43eb-ac45-b6fb6c931932","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e6af044dd579e9b57e2c:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"API Reference","count":15},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Scheduled Tasks","count":5},{"language":"default","tag":"SDKs and Code Samples","count":5},{"language":"default","tag":"References","count":4},{"language":"default","tag":"Others","count":2},{"language":"default","tag":"Pdf","count":2},{"language":"default","tag":"Scrape","count":2},{"language":"default","tag":"Animated Screenshot","count":2}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"endpoints/get-tasks-id","slug":"/endpoints/get-tasks-id","pageMetadata":{"title":"Get Task","api":"GET https://api.screenshotmax.com/v1/tasks/{id}","description":"Get a scheduled task","href":"/endpoints/get-tasks-id"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a scheduled task\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`It’s simple to use: you only need to submit your `,_jsx(_components.code,{children:`access_key`}),`. The API will return the list of your scheduled tasks for your account.`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Plan Requirement`})}),_jsxs(_components.p,{children:[`Scheduled Tasks are available only on the `,_jsx(_components.strong,{children:`Scale plan`}),`.\nUpgrade your account via the Subscription / Dashboard `,_jsx(_components.a,{href:`https://app.screenshotmax.com/subscribe/monthly`,children:`section`}),` to unlock this feature.`]})]}),`\n`,_jsxs(Note,{children:[`Requests to this endpoint are `,_jsx(_components.strong,{children:`not counted against your usage quota,`}),` but they are `,_jsx(_components.strong,{children:`still subject to rate limiting.`}),` This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.`]}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting started`}),`\n`,_jsx(Heading,{level:`3`,id:`rest`,children:`REST`}),`\n`,_jsx(_components.p,{children:`The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.`}),`\n`,_jsx(Heading,{level:`3`,id:`https`,children:`HTTPS`}),`\n`,_jsx(_components.p,{children:`The Task API requires all communications to be secured TLS 1.2 or greater.`}),`\n`,_jsx(Heading,{level:`3`,id:`api-versions`,children:`API Versions`}),`\n`,_jsx(_components.p,{children:`All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.`}),`\n`,_jsx(Heading,{level:`3`,id:`your-access-key`,children:`Your Access Key`}),`\n`,_jsxs(_components.p,{children:[`Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.\nTo authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.\nFor POST and PATCH requests, you can include your access key in the request body as a JSON object.\nYou can also use the `,_jsx(_components.code,{children:`X-Access-Key`}),` header to pass your access key.\nYou can find your access key in your `,_jsx(_components.a,{href:`https://app.screenshotmax.com/access`,children:`account dashboard`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.screenshotmax.com/v1/tasks`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`validation-endpoint`,children:`Validation endpoint`}),`\n`,_jsx(_components.p,{children:`ScreenshotMAX’s Task API simply requires your unique access key. The API will return the scheduled task.`}),`\n`,_jsx(CodeBlock,{numberOfLines:`3`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.screenshotmax.com/v1/tasks/5650820808835072`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`? access_key=YOUR_ACCESS_KEY`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`This was a successful request, so the API returned a 200 OK response with the scheduled task.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5650820808835072`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"task screenshot\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"api\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"screenshot\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"query\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"url=https%3A%2F%2Fexample.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"frequency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"every_month\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"crontab\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"34 9 28 * *\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timezone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Etc/UTC\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"enabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1714296566`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"last_run\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1745832566`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"runs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`12`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Unique identifier for the scheduled task.`})}),`\n`,_jsx(Heading,{level:`3`,id:`query-parameters`,children:`Query parameters`}),`\n`,_jsx(ParamField,{query:`access_key`,type:`string`,required:true,id:`param-access-key`,children:_jsxs(_components.p,{children:[`Your unique access key. You can find your access key in your `,_jsx(_components.a,{href:`https://app.screenshotmax.com/access`,children:`account dashboard`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-parameters`,children:`Response parameters`}),`\n`,_jsxs(_components.p,{children:[`The API response is returned in a universal and lightweight `,_jsx(_components.a,{href:`https://www.json.org/json-en.html`,children:`JSON format`}),`.`]}),`\n`,_jsx(ResponseField,{name:`id`,type:`number`,id:`param-id-1`,children:_jsx(_components.p,{children:`Unique identifier for the scheduled task. This ID is automatically generated when you create a new scheduled task.`})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Name of the scheduled task.`})}),`\n`,_jsx(ResponseField,{name:`api`,type:`string`,id:`param-api`,children:_jsxs(_components.p,{children:[`Service to be used for the scheduled task. Available options include `,_jsx(_components.code,{children:`screenshot`}),`, `,_jsx(_components.code,{children:`screencast`}),`, `,_jsx(_components.code,{children:`pdf`}),` and `,_jsx(_components.code,{children:`scrape`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`query`,type:`string`,id:`param-query`,children:[_jsxs(_components.p,{children:[`Query parameters for the scheduled task without the `,_jsx(_components.code,{children:`access_key`}),` parameter.\nThe querystring can be URL-encoded.`]}),_jsxs(_components.p,{children:[`For example, `,_jsx(_components.code,{children:`url=https%3A%2F%2Fexample.com`}),` is the URL-encoded version of `,_jsx(_components.code,{children:`url=https://example.com`}),`.`]})]}),`\n`,_jsx(ResponseField,{name:`frequency`,type:`string`,id:`param-frequency`,children:_jsxs(_components.p,{children:[`Frequency of the scheduled task. Available options are `,_jsx(_components.code,{children:`every_minute`}),`, `,_jsx(_components.code,{children:`every_hour`}),`, `,_jsx(_components.code,{children:`every_day`}),`, `,_jsx(_components.code,{children:`every_month`}),` and `,_jsx(_components.code,{children:`custom`}),` (use standard cron syntax).`]})}),`\n`,_jsx(ResponseField,{name:`crontab`,type:`string`,id:`param-crontab`,children:_jsxs(_components.p,{children:[`Cron expression used to the scheduled task. Use `,_jsx(_components.a,{href:`https://crontab-generator.com/en`,children:`Unix Cron Format`})]})}),`\n`,_jsx(ResponseField,{name:`timezone`,type:`string`,id:`param-timezone`,children:_jsxs(_components.p,{children:[`Timezone for the scheduled task. Available time zones from the `,_jsx(_components.a,{href:`https://www.iana.org/time-zones`,children:`IANA Time Zone Database`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`enabled`,type:`boolean`,id:`param-enabled`,children:_jsx(_components.p,{children:`Indicates if the scheduled task is enabled or disabled.`})}),`\n`,_jsx(ResponseField,{name:`created`,type:`number`,id:`param-created`,children:_jsx(_components.p,{children:`Unix timestamp in seconds when the scheduled task was created.`})}),`\n`,_jsx(ResponseField,{name:`last_run`,type:`number`,id:`param-last-run`,children:_jsx(_components.p,{children:`Unix timestamp in seconds when the scheduled task was last run.`})}),`\n`,_jsx(ResponseField,{name:`runs`,type:`number`,id:`param-runs`,children:_jsx(_components.p,{children:`Number of times the scheduled task has run.`})}),`\n`,_jsx(Heading,{level:`3`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsx(_components.p,{children:`Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Details`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`200`}),_jsx(_components.td,{children:`OK`}),_jsx(_components.td,{children:`The request was successful.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Bad Request`}),_jsx(_components.td,{children:`The request was rejected due to a missing or invalid parameter.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`Unauthorized`}),_jsx(_components.td,{children:`The request was rejected due to an invalid access key.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`402`}),_jsx(_components.td,{children:`Payment Required`}),_jsx(_components.td,{children:`Access denied due to an unpaid invoice.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Not Found`}),_jsx(_components.td,{children:`The requested resource was not found.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`423`}),_jsx(_components.td,{children:`Locked`}),_jsx(_components.td,{children:`The request was denied due to insufficient quota.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{children:`Too Many Requests`}),_jsx(_components.td,{children:`The rate limit has been exceeded (too many requests per minute).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:`Internal server error`}),_jsx(_components.td,{children:`The request failed due to an internal server error.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Task","api":"GET https://api.screenshotmax.com/v1/tasks/{id}","description":"Get a scheduled task","href":"/endpoints/get-tasks-id"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting started","slug":"getting-started","depth":2,"children":[{"title":"REST","slug":"rest","depth":3,"children":[]},{"title":"HTTPS","slug":"https","depth":3,"children":[]},{"title":"API Versions","slug":"api-versions","depth":3,"children":[]},{"title":"Your Access Key","slug":"your-access-key","depth":3,"children":[]},{"title":"Base URL","slug":"base-url","depth":3,"children":[]},{"title":"Validation endpoint","slug":"validation-endpoint","depth":3,"children":[]},{"title":"Path parameters","slug":"path-parameters","depth":3,"children":[]},{"title":"Query parameters","slug":"query-parameters","depth":3,"children":[]},{"title":"Response parameters","slug":"response-parameters","depth":3,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":3,"children":[]}]}],"codeExamples":{},"endpoint":{"title":"Get Task","path":"/v1/tasks/{id}","servers":[{"url":"https://api.screenshotmax.com"}],"method":"get","request":{"security":[],"parameters":{"query":{"access_key":{"schema":[{"type":"string","description":"Your unique access key. You can find your access key in your account dashboard .","required":true}]}},"header":{},"cookie":{},"path":{"id":{"schema":[{"type":"string","description":"Unique identifier for the scheduled task.","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"number","description":"Unique identifier for the scheduled task. This ID is automatically generated when you create a new scheduled task."}],"name":[{"type":"string","description":"Name of the scheduled task."}],"api":[{"type":"string","description":"Service to be used for the scheduled task. Available options include `screenshot` , `screencast` , `pdf` and `scrape` ."}],"query":[{"type":"string","description":"Query parameters for the scheduled task without the `access_key` parameter. The querystring can be URL-encoded. For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com` ."}],"frequency":[{"type":"string","description":"Frequency of the scheduled task. Available options are `every_minute` , `every_hour` , `every_day` , `every_month` and `custom` (use standard cron syntax)."}],"crontab":[{"type":"string","description":"Cron expression used to the scheduled task. Use Unix Cron Format"}],"timezone":[{"type":"string","description":"Timezone for the scheduled task. Available time zones from the IANA Time Zone Database ."}],"enabled":[{"type":"boolean","description":"Indicates if the scheduled task is enabled or disabled."}],"created":[{"type":"number","description":"Unix timestamp in seconds when the scheduled task was created."}],"last_run":[{"type":"number","description":"Unix timestamp in seconds when the scheduled task was last run."}],"runs":[{"type":"number","description":"Number of times the scheduled task has run."}]}}],"examples":{"example":{"value":{"id":123,"name":"\u003cstring>","api":"\u003cstring>","query":"\u003cstring>","frequency":"\u003cstring>","crontab":"\u003cstring>","timezone":"\u003cstring>","enabled":true,"created":123,"last_run":123,"runs":123}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"screenshotmax","siteName":"ScreenshotMAX API","title":"Get Task - ScreenshotMAX API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-27T18:30:59.941Z","originalFileLocation":"endpoints/get-tasks-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a scheduled task\">\u003cmeta data-mint-head name=\"application-name\" content=\"ScreenshotMAX API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Task - ScreenshotMAX API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a scheduled task\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ScreenshotMAX API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.screenshotmax.com/endpoints/get-tasks-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://screenshotmax.mintlify.app/_mintlify/api/og/v2?division=Scheduled+Tasks\u0026amp;title=Get+Task\u0026amp;description=Get+a+scheduled+task\u0026amp;theme=3bcaa92a7300bf8b66c12bab\u0026amp;signature=a575e94554ed6aa8c251b52918237886c9baacf996e31b578f8844bf001836f2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Task - ScreenshotMAX API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a scheduled task\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://screenshotmax.mintlify.app/_mintlify/api/og/v2?division=Scheduled+Tasks\u0026amp;title=Get+Task\u0026amp;description=Get+a+scheduled+task\u0026amp;theme=3bcaa92a7300bf8b66c12bab\u0026amp;signature=a575e94554ed6aa8c251b52918237886c9baacf996e31b578f8844bf001836f2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ScreenshotMAX API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3366FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.screenshotmax.com/endpoints/get-tasks-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/endpoints/get-tasks-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.screenshotmax.com/#organization\",\"name\":\"ScreenshotMAX API\",\"url\":\"https://docs.screenshotmax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/screenshotmax/T1xOqe1MKSP6l0-_/logo/logo-light.png?fit=max\u0026auto=format\u0026n=T1xOqe1MKSP6l0-_\u0026q=85\u0026s=4b3619eb6512d1558a324ac0cc879acc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.screenshotmax.com#website\",\"name\":\"ScreenshotMAX API\",\"url\":\"https://docs.screenshotmax.com\",\"publisher\":{\"@id\":\"https://docs.screenshotmax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id#webpage\",\"url\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id\",\"name\":\"Get Task\",\"description\":\"Get a scheduled task\",\"dateModified\":\"2025-10-27T18:30:59.941Z\",\"isPartOf\":{\"@id\":\"https://docs.screenshotmax.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Scheduled Tasks\",\"item\":\"https://docs.screenshotmax.com/endpoints/get-tasks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Task\",\"item\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id#apireference\",\"headline\":\"Get Task\",\"name\":\"Get Task\",\"description\":\"Get a scheduled task\",\"url\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.screenshotmax.com/endpoints/get-tasks-id#webpage\"},\"dateModified\":\"2025-10-27T18:30:59.941Z\",\"publisher\":{\"@id\":\"https://docs.screenshotmax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.screenshotmax.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ScreenshotMAX API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ScreenshotMAX API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/start/introduction"}]},{"tab":"API Reference","groups":[{"group":"Screenshot","pages":[{"title":"Screenshot","api":"GET https://api.screenshotmax.com/v1/screenshot","href":"/endpoints/get-screenshot"},{"title":"Screenshot","api":"POST https://api.screenshotmax.com/v1/screenshot","href":"/endpoints/post-screenshot"}]},{"group":"Animated Screenshot","pages":[{"title":"Screencast","api":"GET https://api.screenshotmax.com/v1/screencast","href":"/endpoints/get-screencast"},{"title":"Screencast","api":"POST https://api.screenshotmax.com/v1/screencast","href":"/endpoints/post-screencast"}]},{"group":"Pdf","pages":[{"title":"Pdf","api":"GET https://api.screenshotmax.com/v1/pdf","href":"/endpoints/get-pdf"},{"title":"Pdf","api":"POST https://api.screenshotmax.com/v1/pdf","href":"/endpoints/post-pdf"}]},{"group":"Scrape","pages":[{"title":"Scrape","api":"GET https://api.screenshotmax.com/v1/scrape","href":"/endpoints/get-scrape"},{"title":"Scrape","api":"POST https://api.screenshotmax.com/v1/scrape","href":"/endpoints/post-scrape"}]},{"group":"Scheduled Tasks","pages":[{"title":"List Tasks","api":"GET https://api.screenshotmax.com/v1/tasks","description":"Get all your scheduled tasks","href":"/endpoints/get-tasks"},{"title":"Get Task","api":"GET https://api.screenshotmax.com/v1/tasks/{id}","href":"/endpoints/get-tasks-id"},{"title":"Create Task","api":"POST https://api.screenshotmax.com/v1/tasks","description":"Create a new scheduled task","href":"/endpoints/post-tasks"},{"title":"Update Task","api":"PATCH https://api.screenshotmax.com/v1/tasks/{id}","href":"/endpoints/patch-tasks"},{"title":"Delete Task","api":"DELETE https://api.screenshotmax.com/v1/tasks/{id}","href":"/endpoints/delete-tasks"}]},{"group":"Others","pages":[{"title":"Devices","api":"GET https://api.screenshotmax.com/v1/devices","href":"/endpoints/devices"},{"title":"Usage","api":"GET https://api.screenshotmax.com/v1/usage","href":"/endpoints/usage"}]}]},{"tab":"LLMs Integrations","href":"https://docs.screenshotmax.com/llms-full.txt"}]},"title":"Get Task - ScreenshotMAX API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js"]}