Skip to main content
Only two Forms scopes. manage = operate forms; submit = receive submissions.

​
How to send the key

or x-api-key.
The API Key belongs to one workspace. In v1 do not send x-workspace-id.

​
Scopes

  • GET / POST /v1/forms/lists
  • GET / PATCH / DELETE /v1/forms/lists/{id}
  • GET /v1/forms/lists/{id}/subscriptions
  • GET /v1/forms/lists/{id}/subscriptions/stats
  • GET /v1/forms/lists/{id}/subscriptions/export (CSV)
  • DELETE /v1/forms/lists/{id}/subscriptions/{subscriptionId}
  • GET /v1/forms/subscriptions (workspace-wide filter)
  • POST /v1/forms/subscriptions
  • POST /v1/forms/subscriptions/confirm
  • POST /v1/forms/subscriptions/{id}/cancel

​
Common combinations

​
Webhooks

Configure form.* events under Integrations → Webhooks, see Webhook events.

​
Next steps