Benefits

A GET action to check the EAP benefit configuration

A GET request to the benefits endpoint is used to list all the benefits of an organisation

get/api/v2/partner/organisations/{organisation_id}/eap

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/organisations/{organisation_id}/eap
  • Auth: API key in header Authorization

Path parameters

organisation_idinteger required

ID of the organisation for which to get the EAP benefit data

Response

Benefits returned successfully

successboolean

Example response

{
  "success": true,
  "eap": {
    "start_date": "2025-01-01",
    "end_date": "2025-01-31",
    "sso_company_name": "Acme Ltd",
    "staff_count": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.