BIbindbee
Dependents

Get Dependent By Id

Changed on

Returns a Dependent object with the given id.

get/api/hris/v1/dependents/{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 holding this position.

first_namestring nullable required

The dependent's first name

middle_namestring nullable required

The dependent's middle name

last_namestring nullable required

The dependent's last name

relationshipstring nullable required

The dependent's relationship with this employee. If the value is not one of the defined enum values, the original value passed through will be returned.

date_of_birthstring nullable required

The dependent's date of birth

genderstring nullable required

The dependent's gender. If the value is not one of the defined enum values, the original value passed through will be returned.

phone_numberstring nullable required

The dependent's phone number

is_studentboolean nullable required

Indicates if the dependent is a student

ssnstring nullable required

The dependent's SSN

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": "018abccb-c4a9-72f6-be1d-3fc7aaf2be67",
  "home_location": {
    "name": "UK-HO-London",
    "location": "UK-HO-London",
    "street_1": "1011",
    "street_2": "Lane number 4, Golden Villa",
    "city": "London",
    "state": "LND",
    "postal_code": "56273",
    "country": "UK"
  },
  "first_name": "Aayushi",
  "middle_name": "Olivia",
  "last_name": "Rai",
  "relationship": "SPOUSE",
  "date_of_birth": "1995-04-16T00:00:00Z",
  "gender": "FEMALE",
  "phone_number": "+44-208-555-2112",
  "is_student": true,
  "ssn": "555-22-5555"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the CHILD enum value from the response property for the response status

    • info

      removed the DOMESTIC_PARTNER enum value from the response property for the response status

    • info

      removed the FEMALE enum value from the response property for the response status

    • info

      removed the MALE enum value from the response property for the response status

    • info

      removed the NON-BINARY enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the PARENT enum value from the response property for the response status

    • info

      removed the PREFER_NOT_TO_DISCLOSE enum value from the response property for the response status

    • info

      removed the SIBLING enum value from the response property for the response status

    • info

      removed the SPOUSE enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API