---
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# 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](https://docs.oysterhr.com/v0.1/reference/get_v0-1-hiring-employments-id-onboarding-form-documents-field-or-document-id)

### v0.1 Credit notes API updates

* Release includes the following field name changes in the [Retrieve all credit notes](https://docs.oysterhr.com/v0.1/reference/get_v0-1-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](https://docs.oysterhr.com/v0.1/reference/get_v0-1-benefits-engagements-engagement-id-provisioning) and [Provision benefits](https://docs.oysterhr.com/v0.1/reference/put_v0-1-benefits-engagements-engagement-id-provisioning) endpoints: path updated from `/provisionings` to `/provisioning`

## v1 API

### v1 Employments API updates

* Release includes: [Verify agreement](https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-agreements-agreement-id-verify), [Retrieve an individual agreement](https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-agreements-agreement-id), [Retrieve all agreements for employment](https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-agreements), [Invite team member](https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-team-member-invite), [Get a document from the onboarding form](https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-onboarding-form-documents-field-or-document-id), [Fetch the employment onboarding form](https://docs.oysterhr.com/reference/get_v1-hiring-employments-onboarding-form)

## Webhooks

### Hiring webhooks updates

* Release includes: [hiring.task\_updated](https://docs.oysterhr.com/reference/post_hiring-task-updated)