Developer docsChangelog and versioning
Changelog

Changelog and versioning

What changed in the API, newest first, and how we change it without breaking your code.

Updated View as Markdown

How versions work

The API is v1, and v1 is stable. The version is in every address (/api/v1/…), so you always know which one you're calling.

Within v1 we only make changes that keep working code working:

  • new endpoints and new MCP tools;
  • new optional parameters and body fields;
  • new fields in answers. Ignore fields you don't know;
  • new values where a field says it can grow, like timeline event names;
  • clearer wording in error messages. Use the status code, not the words.

A breaking change, like removing or renaming a field or endpoint, or changing what a field means, only happens with at least 6 months' notice. We'll write to the person who made each key, mark it in the reference, and list it here with the date it ends. Fixes for security problems are the one exception, and we'll explain them here.

Changes

Sun 11 Oct 2026

  • Developer docs: these guides, and a reference with Try it for every endpoint.
  • The OpenAPI 3.1 spec, at https://app.userookery.com/api/v1/openapi.json and userookery.com/developers/openapi.json. It's made from the same definitions the API runs on.
  • The API answers browser requests from userookery.com, for Try it. Other websites still can't call it from a browser.
  • GET /me, to check a key, is now in the reference. It needs read, which every key has.
  • Webhooks: ten signed events, from client.replied to booking.cancelled, set up in Settings → Integrations → Webhooks, with retries for about a day, a delivery log and Resend. See Webhooks and the event reference.

Sat 10 Oct 2026

  • v1 opens: the REST API and the MCP server, with API keys scoped to read, write, draft and send.
  • Ask customers for documents, with request_documents or documents on a reply.
  • A key sees the team inboxes and its maker's private inboxes. Anyone else's private conversations answer 404.