> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.kota.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kota.io/_mcp/server.

# Retrieve an employee offer

GET https://test.api.kota.io/employees/{employee_id}/health_insurance/offers/{employee_offer_id}

Retrieve group's health insurance `offer` for an `employee` by `employee_offer_id`. For intent-based enrolments the offer id is the enrolment intent id.

Reference: https://docs.kota.io/api-reference/health-insurance/retrieve-employee-health-insurance-offer

## Authentication

- `Authorization` header (bearer token, required) — Authorization header using the Bearer scheme

## Servers

- `https://test.api.kota.io` (test, default)
- `https://api.kota.io` (production)

## Request

### Path parameters

- `employee_id` (string, required)
- `employee_offer_id` (string, required)

### Headers

- `X-Platform-Id` (string, optional) — The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

## Response

### 200

OK

- `id` (string, required) — Unique identifier for offer
- `employer_id` (string, required) — The Id of the employer for which the offer is available
- `employee_id` (string, required) — The Id of the employee for which the offer is available
- `status` (enum, required) — Current status of offer
  - Allowed values: `action_required`, `not_undertaken`, `accepted`
- `coverage_level` (HealthInsuranceCoverageLevelResponse, required) — Details about the coverage level for the offer. Only a single level of cover is available for a specific employee!
- `object` (string, optional) — The object type
- `external_customer_id` (string, optional, nullable) — A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.
- `required_action` (HealthInsuranceRequiredActionResponse, optional) — Required action to progress the offer, if any. Set only when `status` is `action_required`.

## Errors

### 404 Not Found Error

Not Found

- `type` (string, optional, nullable)
- `title` (string, optional, nullable)
- `status` (integer, optional, nullable)
- `detail` (string, optional, nullable)
- `instance` (string, optional, nullable)

## Types

### HealthInsuranceCoverageLevelResponse

- `plan_id` (string, required) — Unique identifier for the health insurance plan
- `plan_name` (string, required) — Name of the health insurance plan
- `plan_currency` (enum, required) — Currency code of the health insurance plan
  - Allowed values: `eur`, `aed`, `afn`, `xcd`, `all`, `amd`, `aoa`, `ars`, `usd`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `xof`, `bgn`, `bhd`, `bif`, `bmd`, `bnd`, `bob`, `bov`, `brl`, `bsd`, `inr`, `btn`, `nok`, `bwp`, `byn`, `bzd`, `cad`, `xaf`, `cdf`, `chf`, `che`, `chw`, `nzd`, `clp`, `clf`, `cny`, `cop`, `cou`, `crc`, `cup`, `cuc`, `cve`, `ang`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `mad`, `ern`, `etb`, `fjd`, `fkp`, `mdl`, `gbp`, `gel`, `ghs`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `hrk`, `htg`, `huf`, `idr`, `xdr`, `ils`, `iqd`, `irr`, `isk`, `jmd`, `jod`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `kpw`, `krw`, `kwd`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `zar`, `lyd`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mru`, `mur`, `mvr`, `mwk`, `mxn`, `mxv`, `myr`, `mzn`, `nad`, `xpf`, `ngn`, `nio`, `npr`, `omr`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sdg`, `sek`, `sgd`, `shp`, `sll`, `sos`, `srd`, `ssp`, `stn`, `svc`, `xsu`, `syp`, `twd`, `szl`, `thb`, `tjs`, `tmt`, `tnd`, `top`, `try`, `ttd`, `tzs`, `uah`, `ugx`, `usn`, `uyu`, `uyi`, `uyw`, `uzs`, `ves`, `vnd`, `vuv`, `wst`, `yer`, `xua`, `zmw`, `zwl`
- `provider_name` (string, required) — Name of the health insurance provider
- `provider_logo_url` (string, required) — Logo URL of the health insurance provider
- `documents` (list of HealthInsuranceCoverageLevelDocumentResponse, required) — Documents related to the health insurance plan, these documents may change at renewal, this includes the documents like `Insurance Product Information Document`, `Hospital Lists`, `Table of Cover` etc
- `provider_employer_platform_url` (string, optional, nullable) — URL to the health insurance provider's website for Employer Management
- `provider_support_phone` (string, optional, nullable) — Support phone number to the health insurance provider's website for Employer Management

### HealthInsuranceRequiredActionResponse

- `reason` (string, required) — Concise reason for the required action
- `reason_description` (string, required) — Description for the required action
- `code` (string, required) — Identified the type of action required, not unique across health insurance providers
- `due_at` (date, required) — Date and time by which the action is due, if this is not completed then the policy will not be issued.

### HealthInsuranceCoverageLevelDocumentResponse

- `title` (string, required) — Health Insurance Document Title
- `link` (string, required) — Health Insurance Document Link (can be a link to a website or a file path)

## Examples

**Response**

```json
{
  "id": "eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "status": "action_required",
  "coverage_level": {
    "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "plan_name": "string",
    "plan_currency": "eur",
    "provider_name": "string",
    "provider_logo_url": "string",
    "documents": [
      {
        "title": "string",
        "link": "string"
      }
    ],
    "provider_employer_platform_url": null,
    "provider_support_phone": null
  },
  "object": "string",
  "external_customer_id": null,
  "required_action": null
}
```

**SDK Code**

```python
import requests

url = "https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a"

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/offers/eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```