Get Screenshots List

Overview

The Get Screenshots List allows you to retrieve a list of screenshot requests.

Endpoint

GET https://api.peekshot.com/api/v1/screenshots

Request Headers

Header	Description
x-api-key	Your unique API key for authentication.

Query Parameters

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

Example Request (Using Axios)

cURL

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

Node.js

const axios = require('axios');

const config = {
method: 'get',
url: 'https://api.peekshot.com/api/v1/screenshots',
headers: {
'x-api-key': 'your-api-key'
}
};

axios.request(config)
.then(response => console.log(response.data))
.catch(error => console.error(error));

Python

import requests

url = "https://api.peekshot.com/api/v1/screenshots"
headers = {
    "x-api-key": "your-api-key"
}

response = requests.get(url, headers=headers)
print(response.text)

Go

import requests

url = "https://api.peekshot.com/api/v1/screenshots"
headers = {
"x-api-key": "your-api-key"
}

response = requests.get(url, headers=headers)
print(response.text)

Java

import requests

url = "https://api.peekshot.com/api/v1/screenshots"
headers = {
    "x-api-key": "your-api-key"
}

response = requests.get(url, headers=headers)
print(response.text)

PHP

import requests

url = "https://api.peekshot.com/api/v1/screenshots"
headers = {
"x-api-key": "your-api-key"
}

response = requests.get(url, headers=headers)
print(response.text)

Ruby

import requests

url = "https://api.peekshot.com/api/v1/screenshots"
headers = {
    "x-api-key": "your-api-key"
}

response = requests.get(url, headers=headers)
print(response.text)

Example 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
}

Error Responses

Status Code	Error Message	Description
400	Invalid Request	Check your input parameters.
403	Forbidden	Invalid or inactive API key.
500	Internal Server Error	Issue on the server side.

Notes

• API requests must include a valid x-api-key in the headers.

For further assistance, contact [email protected].