Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Screenshots

Get a single screenshot

Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return the same record without side effects.

The Attachable Screenshots feature must be enabled on the account.

get/projects/{project_id}/screenshots/{id}

Path parameters

project_idstring required

Project ID

idstring required

ID

Query parameters

branchstring

specify the branch to use

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
namestring
descriptionstring
screenshot_urlstring
created_atstring date-time
updated_atstring date-time
markers_countinteger

Example response

{
  "id": "d2e056aa9e70b01121f41693e344f5ee",
  "name": "A screenshot name",
  "description": "A screenshot description",
  "screenshot_url": "http://assets.example.com/screenshot.png",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "markers_count": 0
}