Skip to main content

Release status

This documentation describes one specific version of FieldTask's API contract.

Release stageBeta
Contract version2026-11-03-review.2
Contract statusreview-only
Approved for productionNo
Backend buildd9aa3fd43c59

Schemas, permissions, error codes and response headers on every reference page are generated from that contract. Examples are synthetic: their IDs, names and addresses don't belong to real records, and every example is checked against the contract when the site is built.

What beta means​

The REST API, the MCP server, webhooks and these docs are in beta. Endpoints, tools, fields, limits and behaviour can still change before general availability, and FieldTask enables the API organization by organization. Build integrations that tolerate change, as described in Versioning and changes, and check the changelog when you update.

Not decided yet​

caution

Until these are settled, nothing on this site is a commitment about availability, limits, support or compatibility.

  • Addresses. The production API and MCP addresses aren't published yet. Examples use api.fieldtask.example as a placeholder; use the addresses shown in Settings → API connections.
  • Available features. Which optional features are enabled in production.
  • Webhook delivery timing. How soon after a change a webhook is delivered isn't specified.
  • Sandbox. Whether a test environment will be offered.
  • Terms and support. See Support and terms.
  • Change policy. See Versioning and changes.