Dokki API logo
GET
/api/v1/resources/{resource_id}/form

Get form

GET /api/v1/resources/{resource_id}/form

Read the collection-form configuration for a table.

Endpoint

  • Method: GET

  • Path: /api/v1/resources/{resource_id}/form

  • Required scope: form:read

  • Base URL: https://dokki.one

Parameters

  • resource_id — required path UUID for a table the API key can access.

This endpoint only supports table resources. If the table has no form, form is null.

Request example

curl "https://dokki.one/api/v1/resources/$TABLE_RESOURCE_ID/form" \
  -H "Authorization: Bearer $DOKKI_API_KEY"

Response

The response contains the table resource, resolved access, and form. When present, form contains its IDs, configuration, active state, submission count, timestamps, public-form token, and webhook token.

Treat both tokens as secrets: the public form token accepts anonymous form submissions, and the webhook token authorizes webhook schema reads and writes. Do not expose a response from this endpoint in client-side code or logs.

{
  "resource": { "id": "8f3d...", "type": "table", "name": "Requests" },
  "access": { "permission": "read" },
  "form": {
    "is_active": true,
    "config": { "title": "Request intake", "fields": [] },
    "submission_count": 12
  }
}

Errors

  • 400 — the resource is not a table.

  • 401 — missing or invalid API key.

  • 403 — API key lacks form:read or current resource access.

  • 404 — resource is unavailable to the caller.