Benefits

List all benefits available to an organisation

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

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

Request

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

Path parameters

organisation_idinteger required

ID of the organisation for which we are listing benefits

Response

Benefits returned successfully

successboolean

Example response

{
  "success": true,
  "benefits": [
    {
      "start_date": "2025-04-01",
      "end_date": "2026-03-31",
      "relative_url": "home_and_electronics",
      "quote_type": "NHS",
      "limit_value": 1000,
      "sso_company_name": "Acme Ltd"
    }
  ]
}

Changes

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