Oyster API updates - 2 June 2025

v0.1 Employment API updates, v0.1 Credit notes API updates, v0.1 Benefits API updates

v1 Employments API updates

Hiring webhooks updates

v0.1 API

v0.1 Employments API updates

• Release includes: Get a document from the onboarding form

v0.1 Credit notes API updates

• Release includes the following field name changes in the Retrieve all credit notes responses: amount updated to totalAmount and availableAmount updated to amountRemaining

v0.1 Benefits API updates

• Release includes the following change to the Retrieve an employment's provisioned benefits and Provision benefits endpoints: path updated from /provisionings to /provisioning

v1 API

v1 Employments API updates

• Release includes: Verify agreement, Retrieve an individual agreement, Retrieve all agreements for employment, Invite team member, Get a document from the onboarding form, Fetch the employment onboarding form

Webhooks

Hiring webhooks updates

• Release includes: hiring.task_updated