Get Cobra Event By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/cobra-events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Connector-Token: <api-key>'

import requests

url = "https://api.bindbee.dev/api/hris/v1/cobra-events/{id}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Connector-Token': '<api-key>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/cobra-events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/cobra-events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Connector-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/cobra-events/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/cobra-events/{id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/cobra-events/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'

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

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "employee": "01a0b3cd-35a5-71df-8636-c86117dbf734",
  "is_employee_covered": true,
  "covered_dependents": [
    "018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
  ],
  "qualifying_event_reason": "Termination",
  "event_category": "TERMINATION",
  "qualifying_event_date": "2026-09-30",
  "linked_employer_benefits": [
    "018b18ef-c488-7d40-9131-91bbc47c1007"
  ],
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

GET

api

hris

cobra-events

{id}

Get Cobra Event By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/cobra-events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Connector-Token: <api-key>'

import requests

url = "https://api.bindbee.dev/api/hris/v1/cobra-events/{id}"

headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Connector-Token': '<api-key>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/cobra-events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/cobra-events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Connector-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/cobra-events/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/cobra-events/{id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Connector-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/cobra-events/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'

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

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "employee": "01a0b3cd-35a5-71df-8636-c86117dbf734",
  "is_employee_covered": true,
  "covered_dependents": [
    "018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
  ],
  "qualifying_event_reason": "Termination",
  "event_category": "TERMINATION",
  "qualifying_event_date": "2026-09-30",
  "linked_employer_benefits": [
    "018b18ef-c488-7d40-9131-91bbc47c1007"
  ],
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

default:<BINDBEE_API_KEY>

required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token

string

header

default:<CONNECTOR_TOKEN>

required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Path Parameters

string<uuid>

required

Query Parameters

include_raw_data

boolean

default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

Example:

false

expand

string | null

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:

"manager[first_name,last_name]"

Response

Successful Response

The COBRA Event object groups everyone who became COBRA eligible through the same qualifying event: the employee, their covered dependents, or both.

string<uuid>

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

modified_at

string<date-time>

required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields

Custom Fields · object | null

required

The custom fields related to the model

Example:

{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}

employee

any | null

required

The employee the event belongs to. Populated even when only dependents are affected, so the employee is always known.

Example:

"01a0b3cd-35a5-71df-8636-c86117dbf734"

is_employee_covered

boolean | null

required

Whether the employee is a beneficiary of this event, as on a termination. False for a dependent-only event, such as a divorce or a dependent aging out.

Example:

true

covered_dependents

any[] | null

required

The dependents who are beneficiaries of this event.

Example:

["018abccb-c4a9-72f6-be1d-3fc7aaf2be67"]

qualifying_event_reason

string | null

required

The reason for the event as recorded in the third-party system, passed through as is.

Example:

"Termination"

event_category

string | null

required

The federal COBRA qualifying event derived from qualifying_event_reason. OTHER when the reason matches no federal event.

Example:

"TERMINATION"

qualifying_event_date

string | null

required

The date of the qualifying event as the third-party system records it. It can differ from the date coverage is lost, so COBRA notice deadlines are not always counted from it.

Example:

"2026-09-30"

linked_employer_benefits

any[] | null

required

The employer benefit plans the event relates to. Null when the third-party system does not tie COBRA data to plans.

Example:

["018b18ef-c488-7d40-9131-91bbc47c1007"]

raw_data

Raw Data · object | null

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

API Basics

Platform

HR & Payroll (HRIS)

Recruiting (ATS)

Learning (LMS)

Get Cobra Event By Id

Authorizations

Path Parameters

Query Parameters

Response