Benefit

Get Benefits

This endpoint retrieves all benefit definitions configured for an organisation. Available for AU, NZ, and UK organisations only.

GET

https://api.employmenthero.com/api/v1/organisations/:organisation_id/benefits

Path Parameters

organisation_iduuidrequired

The ID of the organisation to retrieve benefits for.

Response Body

Returns all benefit definitions configured for the organisation in a single response.

dataobject

itemsobject[]

List of benefit definitions configured for the organisation.

iduuid

Unique identifier for the benefit definition.

namestring

The name of the benefit (e.g. "Phone allowance", "Health insurance").

descriptionstring

A description of the benefit.

countrystring

The ISO country code the benefit applies to (e.g. "AU", "GB").

currencystring

The ISO currency code derived from the benefit's country (e.g. "AUD", "GBP").

Example

curl -X GET \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/benefits" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

{  "data": {    "items": [      {        "id": "0ba57ae3-b2ec-4a58-be81-488fa438d4f8",        "name": "Phone allowance",        "description": "Phone allowance",        "country": "AU",        "currency": "AUD"      }    ]  }}