Versioning

API versions and availability

REST endpoints use the /v1 URL prefix. That version is separate from whether an API family is generally available or in alpha. The lookup-table API is generally available; the other documented families and MCP require an alpha invitation. See permissions and availability.

Generally available API compatibility

Changes to the generally available lookup-table API are additive within v1: new endpoints, optional request fields, response fields, or error codes under existing HTTP statuses. Existing members keep their names, types, and meanings. Accepted inputs are not narrowed, and new required inputs are not added.

Clients should ignore unknown response fields and handle an unfamiliar error code according to its HTTP status. A breaking change to this generally available API uses a new major version alongside v1, with a published deprecation period before an older version is withdrawn.

Alpha APIs and MCP

Alpha endpoints, MCP actions, permissions, and request or response fields can change before general availability. Do not assume an alpha interface is frozen because its URL includes v1. Check the current resource reference and rediscover the MCP tools when updating a connection.

The public OpenAPI document describes generally available families. Use this site's resource references and MCP action reference for the documented alpha interfaces.

Data, access, and resource versions

An API version does not preserve an organization's data, configuration, or access permissions. An admin can revoke a connection or change which tables, objects, and workflows it can use. A resource may then be absent from a list or unavailable to that connection.

Where a write requires a resource version or plan revision, read the current value and send it unchanged. If the resource changes, read it again and review the change before retrying. See writes, versions, and retries.

Pagination and consistency follow each endpoint's rules; v1 is not a fixed export of your data. Lookup-table field behavior and live pagination are documented in their own guides.