---
title: "Screenshot state of up to 50 projects at once (project lists); projects the caller cannot see are left out"
method: GET
path: "/screenshots"
tags: ["Projects"]
---

# Screenshot state of up to 50 projects at once (project lists); projects the caller cannot see are left out

`GET /screenshots`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/screenshots`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Query parameters

- `projectIds` string, required: Up to 50 project ids, comma-separated

## Response `200`

Screenshot states

- object
  - `screenshots` object[], required
    - `projectId` string, uuid, required
    - `configured` boolean, required
    - `status` 'off' | 'none' | 'pending' | 'ready' | 'failed', required
    - `version` string, nullable, required
    - `contentType` 'image/webp' | 'image/jpeg' | 'null', nullable, required
    - `capturedAt` string, nullable, required: ISO-8601 timestamp
    - `url` string, nullable, required
    - `refreshing` boolean, required
    - `requestedAt` string, nullable, required: ISO-8601 timestamp
    - `lastError` 'no_public_url' | 'invalid_job' | 'dns_failure' | 'blocked_address' | 'navigation_blocked' | 'unreachable' | 'timeout' | 'protected' | 'site_error' | 'too_large' | 'browser_failed' | 'capture_timeout' | 'storage_full' | 'null', nullable, required
    - `lastAttemptAt` string, nullable, required: ISO-8601 timestamp
    - `refreshAvailableAt` string, nullable, required: ISO-8601 timestamp
    - `sizes` object, required
      - `full` object, required
        - `width` integer, required
        - `height` integer, required
      - `thumb` object, required
        - `width` integer, required
        - `height` integer, required

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: The project has no live site to capture (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Screenshots are not set up on this server (code not_configured)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)