Changelog

What changed in the API, release by release.

Each entry lists what changed in the API's description since the one before, generated from the two descriptions themselves, with a line in words where it helps.

30 October 2026: version 0.1.0

The inbox tells finance what is waiting on them: an item's ask may now be export (approved claims to export) or pay (exported claims to record as paid), with entity.type finance and the workspace's wsp_… id, since the item covers its claims together. Treat an ask or a type you don't know as a link to its web_url.

27 October 2026: version 0.1.0

The inbox lists expense claims waiting on your approval: an item's entity.type may now be expense_claim, with an exp_… id. Treat a type you don't know as a link to its web_url.

  • error: GET /v1/workspaces/{workspace_id}/inbox added the new expense_claim enum value to the data/items/entity/type response property for the response status 200 [response-property-enum-value-added]. The server may now return a value the previous contract excluded, so a client written against it may not handle the response. If the value set is meant to grow, declare it with x-extensible-enum.

25 October 2026: version 0.1.0

The calendar lists every person you may see, away or not, as the web app's wallchart does; a preview's warnings come as {code, message} in the reader's language.

  • error: POST /v1/workspaces/{workspace_id}/timeoff/requests/preview the warnings/items/ response's property type changed from string to object for status 200 [response-property-type-changed].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the new optional query request parameter group [new-optional-request-parameter].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/available to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/birthdays to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/days/items/colour to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/days/items/icon to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/days/items/request_id to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/department to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property data/items/non_working to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/calendar added the required property departments to the response with the 200 status [response-required-property-added].
  • info: GET /v1/workspaces/{workspace_id}/timeoff/leave-types added the required property data/items/icon to the response with the 200 status [response-required-property-added].
  • info: POST /v1/workspaces/{workspace_id}/timeoff/requests/preview added the required property warnings/items/code to the response with the 200 status [response-required-property-added].
  • info: POST /v1/workspaces/{workspace_id}/timeoff/requests/preview added the required property warnings/items/message to the response with the 200 status [response-required-property-added].
  • error: POST /v1/workspaces/{workspace_id}/timeoff/requests removed the success response with the status 200 [response-success-status-removed].
  • warning: POST /v1/workspaces/{workspace_id}/timeoff/requests deleted the query request parameter preview [request-parameter-removed]. This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.
  • info: POST /v1/workspaces/{workspace_id}/timeoff/requests/preview endpoint added [endpoint-added].

24 October 2026: version 0.1.0

  • info: GET /v1/me removed the 401.00 enum value from the status response property for the response status 401 [response-property-enum-value-removed].
  • info: GET /v1/me the status response property's max was set to 9007199254740991.00 for the response status 401 [response-property-max-set].
  • info: GET /v1/me the status response property's min was set to -9007199254740991.00 for the response status 401 [response-property-min-set].
  • info: GET /v1/me the status response's property type was narrowed from number to integer for status 401 [response-property-type-specialized].
  • info: GET /v1/me/devices removed the 401.00 enum value from the status response property for the response status 401 [response-property-enum-value-removed].
  • info: GET /v1/me/devices the status response property's max was set to 9007199254740991.00 for the response status 401 [response-property-max-set].
  • info: GET /v1/me/devices the status response property's min was set to -9007199254740991.00 for the response status 401 [response-property-min-set].
  • info: GET /v1/me/devices the status response's property type was narrowed from number to integer for status 401 [response-property-type-specialized].
  • info: DELETE /v1/me/devices/{device_id} removed the 401.00 enum value from the status response property for the response status 401 [response-property-enum-value-removed].
  • info: DELETE /v1/me/devices/{device_id} removed the 404.00 enum value from the status response property for the response status 404 [response-property-enum-value-removed].
  • info: DELETE /v1/me/devices/{device_id} the status response property's max was set to 9007199254740991.00 for the response status 401 [response-property-max-set].
  • info: DELETE /v1/me/devices/{device_id} the status response property's max was set to 9007199254740991.00 for the response status 404 [response-property-max-set].
  • info: DELETE /v1/me/devices/{device_id} the status response property's min was set to -9007199254740991.00 for the response status 401 [response-property-min-set].
  • info: DELETE /v1/me/devices/{device_id} the status response property's min was set to -9007199254740991.00 for the response status 404 [response-property-min-set].
  • info: DELETE /v1/me/devices/{device_id} the status response's property type was narrowed from number to integer for status 401 [response-property-type-specialized].
  • info: DELETE /v1/me/devices/{device_id} the status response's property type was narrowed from number to integer for status 404 [response-property-type-specialized].
  • info: DELETE /v1/me/signature endpoint added [endpoint-added].
  • info: GET /v1/me/signature endpoint added [endpoint-added].
  • info: PUT /v1/me/signature endpoint added [endpoint-added].
  • info: POST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/save-as-template the scope request property default value personal was removed [request-property-default-value-removed].
  • info: POST /v1/workspaces/{workspace_id}/timeoff/requests the end_portion request property default value end_of_day was removed [request-property-default-value-removed].
  • info: POST /v1/workspaces/{workspace_id}/timeoff/requests the start_portion request property default value morning was removed [request-property-default-value-removed].

24 October 2026: version 0.1.0, identity

Apps sign people in with OAuth 2.1 and PKCE, servers with client credentials, and people make personal tokens for their own scripts. New: POST /v1/auth/token, POST /v1/auth/revoke, GET /v1/me, GET /v1/me/devices and DELETE /v1/me/devices/{device_id}.

24 October 2026: version 0.1.0

The API's description, its generated clients and this reference are published for the first time. Two operations for our own apps (finding the region an account lives in, and the app's configuration); no public operations yet.

On this page