> 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. # List all employer policies GET https://test.api.kota.io/employers/{employer_id}/health_insurance/policies Returns a list of group health insurance `policies` for an `employer`. The `policies` are returned sorted by creation date, with the most recent `policy` appearing first. Reference: https://docs.kota.io/api-reference/health-insurance/list-employer-health-insurance-policies ## 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 - `employer_id` (string, required) ### Query parameters - `status` (string, optional) — Multiple values can be provided by separating them with a comma. Allowed values are: `scheduled`, `active`, `expired`, `cancelled`. - `page` (integer, optional) — The page of results to return. Defaults to 1 if not provided. - `page_size` (integer, optional) — The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100. ### 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 - `items` (list of EmployerHealthInsurancePolicyResponse, required) — A paginated array containing the response elements - `page` (integer, required) — The current page of the results - `page_size` (integer, required) — The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size - `total_count` (integer, required) — The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page. - `has_next_page` (boolean, optional) — Whether there are more pages available after this page - `has_previous_page` (boolean, optional) — Whether there are more pages available before this page ## Types ### EmployerHealthInsurancePolicyResponse - `id` (string, required) — Unique identifier for policy - `employer_id` (string, required) — The Id of the employer for which the policy is created - `start_date` (date, required) — Policy starts on this date - `end_date` (date, required) — Policy ends on this date - `status` (enum, required) — Current status of policy - Allowed values: `scheduled`, `active`, `expired`, `cancelled` - `enrolment_type` (enum, required) — Enrolment type of the policy - Allowed values: `opt_out`, `opt_in` - `renewal` (GetEmployerHealthPolicyRenewal, required) — Renewal information for the policy - `employer_cancellation_period_length` (integer, required) — How many days the employer has to cancel the policy since the policy starts - `coverage_levels` (list of HealthInsuranceCoverageLevelResponse, required) — Represents the available coverage levels for this policy - `object` (string, optional) — The object type - `cancellation_date` (date, optional, nullable) — Policy was cancelled on this date, if cancellation occured - `group_policy_number` (string, optional, nullable) — Group’s health insurance policy number, if available ### GetEmployerHealthPolicyRenewal - `status` (enum, required) — The current status of the renewal - Allowed values: `upcoming`, `open`, `renewed`, `cancelled` - `renewal_date` (date, required) — Policy renewal date - `window_start_date` (date, required) — Renewal window starts on this day - `window_end_date` (date, required) — Renewal window ends at the end of this day - `decision_confirmed` (boolean, required) — Whether the decision to renew the policy has been confirmed - `renewed_health_insurance_id` (string, optional, nullable) — The ID of the renewed health insurance policy, if renewed ### 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 ### 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 { "items": [ { "id": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a", "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a", "start_date": "2024-12-01", "end_date": "2024-12-01", "status": "scheduled", "enrolment_type": "opt_out", "renewal": { "status": "upcoming", "renewal_date": "2024-12-01", "window_start_date": "2024-12-01", "window_end_date": "2024-12-01", "decision_confirmed": true, "renewed_health_insurance_id": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_cancellation_period_length": 123, "coverage_levels": [ { "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", "cancellation_date": "2024-12-01", "group_policy_number": null } ], "page": 1, "page_size": 20, "total_count": 1, "has_next_page": false, "has_previous_page": false } ``` **SDK Code** ```python import requests url = "https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies")! 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() ```