Skip to main content

​
Endpoint

GET https://api.screenshotly.dev/v1/screenshots

​
Headers

HeaderRequiredDescription
X-API-KeyYesYour API key

​
Query parameters

​
page
integer
default:"1"
Page number for pagination.
​
limit
integer
default:"10"
Number of screenshots per page.
​
status
string
Filter by status: pending, processing, completed, or failed.
​
format
string
Filter by format: png, jpeg, webp, or pdf.
​
search
string
Search screenshots by URL (case-insensitive partial match).
​
startDate
string
Filter screenshots created on or after this date (ISO 8601 format).
​
endDate
string
Filter screenshots created on or before this date (ISO 8601 format).

​
Response

​
200 OK

{
  "success": true,
  "data": [
    {
      "_id": "67b8a1c2d3e4f5a6b7c8d9e0",
      "url": "https://example.com",
      "name": "Homepage",
      "status": "completed",
      "imageUrl": "https://cdn.screenshotly.dev/screenshots/67b8a1c2d3e4f5a6b7c8d9e0.png",
      "metadata": {
        "fileSize": 245760,
        "format": "png",
        "dimensions": { "width": 1280, "height": 1024 }
      },
      "createdAt": "2025-05-14T10:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 42,
    "page": 1,
    "limit": 10,
    "pages": 5
  }
}

​
Examples

​
List all completed screenshots

curl "https://api.screenshotly.dev/v1/screenshots?status=completed&limit=20" \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY"

​
Search by URL

curl "https://api.screenshotly.dev/v1/screenshots?search=example.com" \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY"

​
Filter by date range

curl "https://api.screenshotly.dev/v1/screenshots?startDate=2025-05-01&endDate=2025-05-31" \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY"