API reference

The reference is generated from the canonical OpenAPI 3.1 document checked into this repository. It contains 29 operations across identity, workspaces, forms, submissions, analytics, and webhooks.

Base URL

https://api.onlyform.com

Authentication

Authenticated endpoints require a scoped key in the X-API-Key header.

curl https://api.onlyform.com/v1/me \
  --header "X-API-Key: $ONLYFORM_API_KEY"

The GET /v1/openapi.json endpoint is public and does not require a key.

Resources

Resource	Operations
Identity	Inspect the key owner and effective scopes.
Workspaces	List, create, read, update, and delete workspaces.
Forms	List, create, read, update, trash, and inspect form blocks.
Submissions	List, read, and permanently delete completed responses.
Analytics	Read aggregate views, starts, submissions, and completion rate.
Webhooks	Manage completed-response webhooks and inspect deliveries.

OpenAPI

Open the hosted OpenAPI document.
Use Download API spec in the page menu to download the documentation copy.

The OpenAPI file is the source of truth for endpoint paths, parameters, schemas, security requirements, response codes, and generated code samples.

Before you integrate

Authentication

Select minimum scopes and manage key rotation.

Errors

Handle stable error codes and request IDs.

Pagination

Traverse list endpoints with opaque cursors.

Form definitions

Update blocks and themes without losing content.

Webhooks Get open api document

⌘I

Get started

Core concepts

API reference

Base URL

Authentication

Resources

OpenAPI

Before you integrate

Authentication

Errors

Pagination

Form definitions

​Base URL

​Authentication

​Resources

​OpenAPI

​Before you integrate

Authentication

Errors

Pagination

Form definitions

Base URL

Authentication

Resources

OpenAPI

Before you integrate