BIbindbee
COBRA Events

Get Cobra Event By Id

Changed on

Returns a COBRA Event object with the given id.

get/api/hris/v1/cobra-events/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

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

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

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

is_employee_coveredboolean nullable 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.

qualifying_event_reasonstring nullable required

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

event_categorystring nullable required

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

qualifying_event_datestring nullable 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 response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "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"
  ]
}

Changes