Skip to main content
GET https://api.craftkit.dev/v1/embed/renders
Lists renders (form submissions and other PDF instances) for the partner’s project so an embedding host can show a document history without a Craftkit dashboard session. Internal preview and dashboard renders are always excluded.

Authorization

Partner API key only. A session JWT is not accepted here.
Authorization
string
required
Bearer ck_live_… — a project API key for a project with the embed partner enabled.

Query parameters

limit
number
default:"100"
Page size. Clamped to 1–500.
offset
number
default:"0"
Rows to skip (clamped to ≥ 0).
templateId
string
Filter to a single Craftkit template UUID.
status
string
Filter by status: queued, rendering, succeeded, failed, or cancelled. Applied after the page is fetched, so a filtered page may return fewer than limit rows.

Response

renders
object[]
limit
number
The effective (clamped) page size.
offset
number
The effective offset.

Errors

StatuscodeMeaning
401missing_authorizationNo Authorization header.
401invalid_credentialsAPI key not found, revoked, or embed not enabled for the project.
cURL
curl "https://api.craftkit.dev/v1/embed/renders?status=succeeded&limit=50" \
  -H "Authorization: Bearer $CRAFTKIT_API_KEY"
200
{
  "renders": [
    {
      "id": "0193c2c3-...",
      "status": "succeeded",
      "source": "form",
      "templateId": "0193c2c3-...",
      "templateName": "Charter Handover",
      "inputData": { "customer": { "name": "Acme Corp" } },
      "downloadUrl": "https://cdn.craftkit.dev/renders/0193c2c3-....pdf",
      "errorMessage": null,
      "durationMs": 1820,
      "createdAt": "2026-06-05T10:00:00.000Z",
      "completedAt": "2026-06-05T10:00:02.000Z"
    }
  ],
  "limit": 50,
  "offset": 0
}