API reference / Screenshots

List screenshot captures

GET/api/v1/screenshots/list

Authorization

Send your API key or MCP OAuth token in the Authorization: Bearer header. Active or trialing Unlimited is required.

Required permission assets:read

Parameters

projectIdqueryrequired

string · uuid

Project ID. generationId is accepted as an alias on project-scoped GET requests.

deviceTypequeryoptional

"mobile" | "tablet" | "desktop" | "watch"

platformqueryoptional

"ios" | "android" | "all"

offsetqueryoptional

integer

minimum: 0 · maximum: 100000

includeSignedqueryoptional

"true"

Include fresh signed media URLs

Request example

Set ALF_API_URL to https://dashboard.applaunchflow.com/api/v1 and ALF_API_KEY to your key. Replace sample IDs with your project’s values.

cURL

curl --request GET \
  --url "$ALF_API_URL/screenshots/list?projectId=11111111-1111-4111-8111-111111111111" \
  --header "Authorization: Bearer $ALF_API_KEY"

Response

Successful JSON responses wrap the result in data, with a request ID in meta.requestId.

screenshotsdatarequired

string[]

assetsdataoptional

object[]

isSampledataoptional

boolean

hasMoredataoptional

boolean

nextOffsetdataoptional

integer | null

View response schema

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "screenshots": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "assets": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "signedUrl": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "signedUrl"
            ]
          }
        },
        "isSample": {
          "type": "boolean"
        },
        "hasMore": {
          "type": "boolean"
        },
        "nextOffset": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "screenshots"
      ]
    },
    "meta": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Errors & retries

Errors use application/problem+json. Check the stable code and keep requestId when contacting support. Respect Retry-After on 429 responses.

See error handling and idempotency →