API reference / Mockups

Get mockup layouts

GET/api/v1/mockups

Authorization

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

Required permission designs:read

Parameters

generationIdqueryrequired

string · uuid

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

variantIdqueryoptional

string · uuid

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/mockups?generationId=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.

projectdatarequired

object | null

View response schema

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "project": {
          "anyOf": [
            {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "project"
      ]
    },
    "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 →