Skip to content

Beautiful Open-Source Form Builder

4.8 KB
Raw Blame
---
title: "Changelog"
description: "Notable updates to the OpnForm API."
---

## 2026-10-28 – Custom SEO and link previews on Pro

OpnForm Cloud Pro workspaces can now publish custom page titles, descriptions, link preview images, and favicons through `seo_meta`. These settings previously required Business. They apply to both OpnForm URLs and custom domains.

Existing saved settings become available when the workspace has a Pro or higher plan; no form update is required. Free workspaces can still save these settings for preview, but public responses omit them.

## 2026-10-07 – Export status polling with API tokens

Personal Access Tokens with `forms-read` can now poll asynchronous exports at
`GET /open/forms/{id}/submissions/export/status/{job_id}`. The previously documented
`/export/{job_id}/status` path was incorrect.

The job must belong to the requested form, and you must have access to that form.
A job from another form returns `404`.

The response documentation now includes the initial `queued` status and matches
the ten fields returned by the API, including `null` values for fields that do not apply.

## 2026-10-03 – Manual integration retries

`POST /open/forms/{form}/integrations/{integrationid}/events/{event}/retry` retries an eligible failure for one integration. It requires `manage-integrations`, preserves attribution metadata, and uses the latest saved submission and current integration settings. The endpoint allows 10 retry requests per minute per user.

Event responses include `can_retry` and `retry_unavailable_reason`. Only the latest eligible failed attempt can be retried. Email retries are blocked if any recipient may already have received the message. The response describes the actual attempt, including failed or skipped outcomes.

## 2026-10-01 – Removed unused public form users endpoint

`GET /forms/{form}/users` has been removed and now returns `404`. The application does not use this endpoint.

To list workspace members, use the authenticated `GET /open/workspaces/{workspaceId}/users` endpoint with the `workspace-users-read` token ability.

## 2026-05-27 – Workspace invite listing requires admin access

The workspace invite listing endpoint now requires workspace admin access:

* `GET /open/workspaces/{workspaceId}/invites`

### What changed

- Non-admin workspace members can no longer list pending or accepted workspace invites.
- Personal Access Tokens must include `workspaces-write` and belong to a workspace admin.
- Invite responses do not expose invite tokens.

### Migration guide

If your integration lists workspace invites, use an admin-owned token with the `workspaces-write` ability. Continue using `GET /open/workspaces/{workspaceId}/users` with `workspace-users-read` when you only need accepted workspace members.

## 2025-01-02 – Optimized form list endpoint

The form list endpoint now returns **lightweight form summaries** for improved performance:

* `GET /open/workspaces/{workspaceId}/forms`

<Info>
The deprecated `GET /open/forms` endpoint (which lists all forms across workspaces) has been removed from the documentation. It remains available for existing Zapier integrations but is not recommended for new implementations.
</Info>

### What changed

This endpoint no longer includes the `properties` array (form fields and blocks) in the response. This significantly reduces response size and improves load times, especially for workspaces with many forms or complex form structures.

### Response fields

The list endpoint now returns these fields:

| Field | Description |
|-------|-------------|
| `id`, `slug`, `title`, `visibility`, `tags` | Core form identification |
| `views_count`, `submissions_count` | Form statistics |
| `created_at`, `updated_at`, `last_edited_human` | Timestamps (ISO 8601 + human-readable) |
| `closes_at`, `is_closed` | Form closure status |
| `max_submissions_count`, `max_number_of_submissions_reached` | Submission limits |
| `is_pro`, `workspace_id`, `share_url` | Workspace and sharing info |

### Migration guide

If your integration relies on `properties` from list endpoints, update your code to:

1. Fetch the form list to get form IDs/slugs
2. Call `GET /open/forms/{slug}` for each form where you need the full `properties` array

```javascript
// Before: properties were included in list response
const forms = await fetch('/open/workspaces/1/forms');

// After: fetch full form details when needed
const formList = await fetch('/open/workspaces/1/forms');
const fullForm = await fetch(`/open/forms/${formList.data[0].slug}`);
// fullForm.properties is now available
```

---

## 2024-06-18 – API creation 🎉

The first public version of the OpnForm REST API is live! You can now:

* Manage workspaces and members
* Create, update and delete forms
* Retrieve and manage submissions
* Generate personal access tokens with granular abilities

Stay tuned for more endpoints and features.