Skip to main content

What is versioned today

The REST API is the first-party surface the 2Fin apps use. It is documented so you can script against your own account, and it changes more often than the Integration API. If you are building something for other people to use, build on the Integration API, webhooks or MCP.

Changes that do not need a new version

These can happen at any time and are listed in the changelog:
  • new endpoints, new optional request fields and new query parameters;
  • new fields in a response or an event’s data;
  • new values in a field that already has several (for example a new source on a webhook, or a new data-history kind);
  • new error messages for the same status code.
Write clients that ignore fields they do not know and handle values they have not seen.

Breaking changes

A change that would break a working client (removing or renaming a field, changing its type or meaning, making an optional field required, removing an endpoint) is not made in place on a versioned surface. It comes as a new Integration API version alongside v1, or a new apiVersion for webhook payloads.

How endpoints are retired

  1. The operation is marked deprecated: true in the OpenAPI document and the change is announced in the changelog, with the replacement where there is one.
  2. When it is removed, the route keeps answering 410 Gone with a message that names the replacement, rather than disappearing into a 404.
Endpoints that answer this way today: The OAuth endpoints moved from /api/chatgpt/oauth/... to /api/oauth/.... The old paths still work, with their own discovery document, for clients that saved them; new clients should use the paths in /.well-known/oauth-authorization-server.

Staying informed

  • The API changelog lists changes that affect API callers, newest first.
  • Watch for deprecated: true in the OpenAPI document, which is the source of the API reference pages.
  • Questions about a change: [email protected].