Skip to content
fieldGRIDField operations
Manager loginTalk to us

Developers

Versioning and changelog

What we promise about the API you build on, and what changed when.

API version
v1 (read-only), October 2026

Versioning policy

  • The version is in the path: /api/v1. v1 is frozen as launched: within v1 we only add. New endpoints, new optional query parameters, new fields in a response, new webhook events and new values of a documented list (for example a new payment method) can appear at any time. Ignore what you do not know.
  • Within v1 we never remove or rename a field, change its type or meaning, make an optional parameter required, change an error code, or change a webhook payload in any of those ways.
  • A change that would break an integration is made only in a new version (/api/v2), which runs alongside v1. We announce it at least 12 months before v1 (or the part of it that changes) stops working, here and by email to the company admins whose keys use it.

Deprecation and sunset

  • Anything deprecated in v1 says so in its responses: a Deprecation header (RFC 9745) from the day it is deprecated and a Sunset header (RFC 8594) with the date it stops working, at least 12 months later. It is also listed below.
  • Every change, additive or not, is in this changelog with its date.

Nothing in v1 is deprecated today. Questions or a change you need: contact@fieldgrid.cloud. The conventions every version follows are on the overview.

Changelog

2026-10-18 · v1 · Invoices, customers, quotes and invoicing webhooks

  • New scopes invoices:read, customers:read and quotes:read.
  • New endpoints GET /api/v1/invoices, /api/v1/invoices/{invoiceId}, /api/v1/invoices/{invoiceId}/pdf, /api/v1/customers, /api/v1/customers/{customerId}, /api/v1/quotes and /api/v1/quotes/{quoteId}.
  • An issued invoice's detail has payments, amountDueMinor, refunds and creditBalanceMinor; updatedAt of an invoice follows its payments, credit notes and refunds, so updatedSince picks them up.
  • New webhook events invoice.issued, credit_note.issued, quote.accepted, payment.recorded and invoice.paid.
  • The 503 invoicing_not_enabled error for the invoicing endpoints until invoicing is switched on for a company.

2026-10-12 · v1 · v1 launched

  • Jobs, people, forms and form submissions (jobs:read, people:read, forms:read), and the job.created, job.updated, job.completed and form.submitted webhooks.