> ## Documentation Index
> Fetch the complete documentation index at: https://docs.craftkit.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List embed renders

> List renders (form submissions / PDF instances) for the partner's
project, excluding internal preview/dashboard renders. Partner secret
key. Offset-paginated.




## OpenAPI

````yaml /openapi.yaml get /v1/embed/renders
openapi: 3.1.0
info:
  title: Craftkit API
  version: 1.0.0
  description: >
    The Craftkit public REST API. Design templates with typed variables, render

    PDFs asynchronously, share and track them, and send them out for digital

    signature.


    ## Authentication


    Most endpoints authenticate with a **project API key** as a bearer token:


    ```

    Authorization: Bearer ck_live_xxxxxxxxxxxxxxxx

    ```


    Keys come in `ck_live_` (production) and `ck_test_` (test) flavours. Embed

    iframe surfaces use a short-lived **embed session JWT** instead, and the

    admin provisioning endpoint uses the deployment-wide `CRAFTKIT_ADMIN_KEY`.

    Inbound webhooks (`/v1/hooks/*`) are not bearer-authed — they are verified
    by

    an HMAC signature header.


    ## Idempotency


    `POST /v1/templates/{slug}/render` and `POST /v1/signatures` accept an

    `Idempotency-Key` request header. Retrying with the same key returns the

    original resource instead of creating (and, for signatures, billing) a

    duplicate.


    ## Errors


    Application errors use a shared envelope:


    ```json

    { "error": { "code": "invalid_request", "message": "...", "issues": { } } }

    ```


    A small number of admin/embed endpoints return a flatter shape

    (`{ "error": "invalid_credentials" }`); those are documented inline.
servers:
  - url: https://api.craftkit.dev
    description: Production
security:
  - bearerApiKey: []
tags:
  - name: Templates
    description: Create, list, fetch, republish, delete templates and enqueue renders.
  - name: Renders
    description: Poll render status, download PDFs, manage shares, email, and engagement.
  - name: Signatures
    description: >-
      Send rendered PDFs out for digital signatures via the signature service
      and track status.
  - name: Webhooks
    description: Inbound webhook receivers (HMAC-authenticated, not bearer-authed).
  - name: Embed
    description: Embed session minting, catalogs, builder templates, form submission.
  - name: Admin
    description: Org provisioning (deployment admin key only).
  - name: System
    description: Health and status.
paths:
  /v1/embed/renders:
    get:
      tags:
        - Embed
      summary: List embed renders
      description: |
        List renders (form submissions / PDF instances) for the partner's
        project, excluding internal preview/dashboard renders. Partner secret
        key. Offset-paginated.
      operationId: listEmbedRenders
      parameters:
        - name: limit
          in: query
          description: Page size (1–500).
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: templateId
          in: query
          description: Filter by Craftkit template UUID.
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          description: Filter by render status.
          schema:
            type: string
            enum:
              - queued
              - rendering
              - succeeded
              - failed
              - cancelled
      responses:
        '200':
          description: Renders.
          content:
            application/json:
              schema:
                type: object
                required:
                  - renders
                  - limit
                  - offset
                properties:
                  renders:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmbedRenderListItem'
                  limit:
                    type: integer
                  offset:
                    type: integer
        '401':
          $ref: '#/components/responses/SimpleUnauthorized'
      security:
        - bearerApiKey: []
components:
  schemas:
    EmbedRenderListItem:
      type: object
      required:
        - id
        - status
        - source
        - templateId
        - inputData
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/RenderStatusEnum'
        source:
          type: string
        templateId:
          type: string
          format: uuid
        templateName:
          type:
            - string
            - 'null'
        inputData:
          type: object
          additionalProperties: true
        downloadUrl:
          type:
            - string
            - 'null'
          format: uri
        errorMessage:
          type:
            - string
            - 'null'
        durationMs:
          type:
            - integer
            - 'null'
        createdAt:
          type: string
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
    RenderStatusEnum:
      type: string
      enum:
        - queued
        - rendering
        - succeeded
        - failed
        - cancelled
    SimpleError:
      type: object
      description: |
        Flat error shape used by some admin/embed endpoints (the value is a
        machine-readable code string rather than the structured envelope).
      required:
        - error
      properties:
        error:
          oneOf:
            - type: string
            - type: object
              properties:
                code:
                  type: string
                message:
                  type: string
        message:
          type: string
        issues: {}
        detail:
          type: string
  responses:
    SimpleUnauthorized:
      description: Missing or invalid credentials (flat error shape).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimpleError'
          example:
            error: invalid_credentials
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      description: >
        Project API key (`ck_live_…` or `ck_test_…`) presented as a bearer
        token.

        For embed partner endpoints this is the partner secret key, which is the

        same credential type.

````