Skip to content

Changelog

Changes to the Integration API, newest first. Each entry is written from the diff on openapi.json — the same file the reference on this site is generated from.

An MCP server for AI assistants. The same API key now also works at https://api.spherum.ae/api/public/v1/mcp, where Claude, Cursor or GitHub Copilot can search employees, invite, re-send, archive and restore. Card contents are never exposed, and nothing changed in the REST calls. MCP is JSON-RPC, so the specification lists no new operation; Connect an AI assistant has the setup.

A bulk invitation call no longer emails anyone by default. Its body takes a new optional field, SendInvitations. Leave it out, or send false, and the batch creates the records and stops there; send true and every row this call creates gets an invitation email. Rows that already existed are never mailed either way — reach them with Re-send an invitation.

This changes behaviour without changing shape: until now a batch emailed every row it created. If your integration relies on those emails, add "SendInvitations": true to the request. A sync that runs on a schedule can now import new people without mailing them each time it finds someone. Invite a batch of people in the reference carries the detail.

A bulk invitation call now carries at most 20 rows. A larger batch is refused whole, with a 400, before any row is read or written — so nothing in it is created and you never have to work out which rows went through. Split it and send again.

This is new: batches were not capped before. If your integration sends a whole roster in one call, it needs to chunk now. Invite a batch of people in the reference carries the detail.

The enumerated fields now declare their type. EmployeeStatus, CompanyType, BulkInvitationRowResult and BulkInvitationSkipReason were published as bare lists of values, so a generated client had to infer that they were strings and the reference rendered them with no type at all. They are strings, and always were: no value was added, removed or renamed, and no request or response changed shape. Regenerate your client if it was built from the earlier document.

Operation summaries are now short titles, and the explanation that used to be in them has moved to each operation’s description. That is a documentation change only — no request, response or status code moved.