Get Screenshots List

GEThttps://api.peekshot.com/api/v1/screenshots

Programmatically list all screenshots in your project or account using the PeekShot List Screenshots API. Supports filtering, pagination, and metadata retrieval so you can organize histories, search by criteria, and manage screenshots in bulk.

Query Parameters

Name	Type	Description
projectId	string	The project ID associated with the screenshot.
url	string	The URL of the website whose screenshot was captured.
status	string	The status of the screenshot request (PENDING, COMPLETE, FAILED).
page	string	The page number for paginated results.
limit	string	The number of results per page.

Headers

Name	Type	Description
x-api-key*	string	Your unique API key for authentication.

curl --location 'https://api.peekshot.com/api/v1/screenshots' \
--header 'x-api-key: your-api-key'

Responses

200Success Response

{
  "status": "success",
  "message": "Screenshots fetched successfully",
  "data": {
    "screenshots": [
      {
        "id": 1,
        "organizationId": 1,
        "projectId": 1,
        "status": "COMPLETE",
        "url": "https://www.yourdomain.com/",
        "screenshotImageSize": 1012796,
        "options": {
          "delay": 0,
          "fresh": true,
          "width": 1680,
          "height": 867,
          "output": "json",
          "retina": true,
          "language": "en-GB,en-US;q=0.9,en;q=0.8",
          "block_ads": false,
          "dark_mode": false,
          "file_type": "jpeg",
          "full_page": false,
          "disable_javascript": false,
          "block_cookie_banner": false
        },
        "screenshotUrl": "https://peekshot.s3.ap-south-1.amazonaws.com/6/image1.jpeg",
        "creditsRequired": 1,
        "duration": "9.864",
        "isActive": true,
        "createdAt": "2025-03-23T09:11:25.906Z",
        "updatedAt": "2025-03-23T09:11:25.906Z",
        "deletedAt": null,
        "deletedByUserId": null
      },
      {
        "id": 2,
        "organizationId": 1,
        "projectId": 2,
        "status": "COMPLETE",
        "url": "https://www.yourdomain2.com/",
        "screenshotImageSize": 258772,
        "options": {
          "delay": 0,
          "fresh": true,
          "width": 1680,
          "height": 867,
          "output": "json",
          "retina": true,
          "language": "en-GB,en-US;q=0.9,en;q=0.8",
          "block_ads": false,
          "dark_mode": false,
          "file_type": "jpeg",
          "full_page": false,
          "disable_javascript": false,
          "block_cookie_banner": false
        },
        "screenshotUrl": "https://peekshot.s3.ap-south-1.amazonaws.com/20/image2.jpeg",
        "creditsRequired": 2,
        "duration": "12.197",
        "isActive": true,
        "createdAt": "2025-03-23T09:02:03.297Z",
        "updatedAt": "2025-03-23T09:02:03.297Z",
        "deletedAt": null,
        "deletedByUserId": null
      }
    ],
    "meta": {
      "currentPage": 1,
      "totalScreenshots": 2,
      "limit": 10
    }
  },
  "statusCode": 200
}