Get Employees - Bindbee Docs

GET

api

hris

employees

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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_number": "1",
      "company": "<any>",
      "first_name": "Kunal",
      "middle_name": "Christopher",
      "last_name": "Tyagi",
      "preferred_name": "Dark Knight",
      "display_full_name": "Kunal Tyagi",
      "username": "kunaltyagi",
      "designation": "Chief Technology Officer",
      "groups": [
        "<any>"
      ],
      "department": "Engineering",
      "division": "Bangalore Division",
      "work_email": "kunal@bindbee.dev",
      "personal_email": "kunaltyagi77@gmail.com",
      "mobile_phone_number": "+1234567890",
      "home_phone_number": "+1234567890",
      "country_code": "+91",
      "home_location": {
        "city": "London",
        "country": "UK",
        "location": "UK-HO-London",
        "name": "UK-HO-London",
        "postal_code": "56273",
        "state": "LND",
        "street_1": "1011",
        "street_2": "Lane number 4, Golden Villa"
      },
      "work_location": {
        "city": "London",
        "country": "UK",
        "location": "UK-HO-London",
        "name": "UK-HO-London",
        "postal_code": "56273",
        "state": "LND",
        "street_1": "1011",
        "street_2": "Lane number 4, Golden Villa"
      },
      "manager": "<any>",
      "pay_group": "<any>",
      "ssn": "1234567890",
      "gender": "MALE",
      "ethnicity": "ASIAN_OR_INDIAN_SUBCONTINENT",
      "marital_status": "SINGLE",
      "date_of_birth": "1986-10-27T00:00:00Z",
      "start_date": "2023-03-05T00:00:00Z",
      "remote_created_at": "2023-03-01T00:00:00Z",
      "employment_status": "INACTIVE",
      "termination_date": "2023-06-05T00:00:00Z",
      "avatar": "http://alturl.com/h2h8m",
      "payroll_run_calendar": "<any>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token

string

required

Query Parameters

manager_id

string

If provided, will only return employees for this manager.

remote_id

string

The third-party API ID of the matching object.

company_id

string

If provided, will only return employees for this company

include_raw_data

boolean

default:false

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

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

employment_status

enum<string>

If provided, will only return employees with this employment status.

Available options:

ACTIVE,

PENDING,

INACTIVE,

ACTIVE_EXTERNAL,

INACTIVE_EXTERNAL

employee_number

string

If provided, will only return employees for this employee number

page_size

integer

default:50

Number of results to return per page. Maximum size is 100.

Required range: 1 <= x <= 1000

cursor

string

The pagination cursor value.

modified_after

string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

expand

string

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.

Response

200

application/json

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

object[]

required

items.id

string

required

Example:

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

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

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

Example:

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

items.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"
}

items.raw_data

object | null

This is the Raw data

Example:

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

items.employee_number

string | null

The employee's number that appears in the third-party integration's UI.

Example:

"1"

items.company

any | null

The ID of the employee's company.

items.first_name

string | null

The employee's first name.

Example:

"Kunal"

items.middle_name

string | null

The employee's middle name.

Example:

"Christopher"

items.last_name

string | null

The employee's last name.

Example:

"Tyagi"

items.preferred_name

string | null

The employee's preferred first name.

Example:

"Dark Knight"

items.display_full_name

string | null

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

Example:

"Kunal Tyagi"

items.username

string | null

The employee's username that appears in the remote UI.

Example:

"kunaltyagi"

items.designation

string | null

The employee's current designation/title

Example:

"Chief Technology Officer"

items.groups

any[] | null

The IDs of the groups that the employee belongs to.

items.department

string | null

The employee's department

Example:

"Engineering"

items.division

string | null

The employee's division

Example:

"Bangalore Division"

items.work_email

string | null

The employee's work email.

Example:

"kunal@bindbee.dev"

items.personal_email

string | null

The employee's personal email.

Example:

"kunaltyagi77@gmail.com"

items.mobile_phone_number

string | null

The employee's mobile phone number.

Example:

"+1234567890"

items.home_phone_number

string | null

The employee's home phone number.

Example:

"+1234567890"

items.country_code

string | null

The employee's country code

Example:

"+91"

items.home_location

object | null

The employee's home address.

Example:

{
  "city": "London",
  "country": "UK",
  "location": "UK-HO-London",
  "name": "UK-HO-London",
  "postal_code": "56273",
  "state": "LND",
  "street_1": "1011",
  "street_2": "Lane number 4, Golden Villa"
}

items.work_location

object | null

The employee's work address.

Example:

{
  "city": "London",
  "country": "UK",
  "location": "UK-HO-London",
  "name": "UK-HO-London",
  "postal_code": "56273",
  "state": "LND",
  "street_1": "1011",
  "street_2": "Lane number 4, Golden Villa"
}

items.manager

any | null

The employee ID of the employee's manager.

items.pay_group

any | null

The employee's pay group

items.ssn

string | null

The employee's social security number.

Example:

"1234567890"

items.gender

string | null

The employee's gender.

Example:

"MALE"

items.ethnicity

string | null

The employee's ethnicity.

Example:

"ASIAN_OR_INDIAN_SUBCONTINENT"

items.marital_status

string | null

The employee's filing status as related to marital status

Example:

"SINGLE"

items.date_of_birth

string | null

The employee's date of birth.

Example:

"1986-10-27T00:00:00Z"

items.start_date

string | null

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

Example:

"2023-03-05T00:00:00Z"

items.remote_created_at

string | null

When the third party's employee was created.

Example:

"2023-03-01T00:00:00Z"

items.employment_status

string | null

The employment status of the employee. Possible values include: ACTIVE, PENDING, INACTIVE, or - in cases where there is no clear mapping - the original value passed through.

Example:

"INACTIVE"

items.termination_date

string | null

The employee's termination date.

Example:

"2023-06-05T00:00:00Z"

items.avatar

string | null

The URL of the employee's avatar image.

Example:

"http://alturl.com/h2h8m"

items.payroll_run_calendar

any | null

The employee's payroll calendar

Get Company By Id Get Create Employee Request Body

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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_number": "1",
      "company": "<any>",
      "first_name": "Kunal",
      "middle_name": "Christopher",
      "last_name": "Tyagi",
      "preferred_name": "Dark Knight",
      "display_full_name": "Kunal Tyagi",
      "username": "kunaltyagi",
      "designation": "Chief Technology Officer",
      "groups": [
        "<any>"
      ],
      "department": "Engineering",
      "division": "Bangalore Division",
      "work_email": "kunal@bindbee.dev",
      "personal_email": "kunaltyagi77@gmail.com",
      "mobile_phone_number": "+1234567890",
      "home_phone_number": "+1234567890",
      "country_code": "+91",
      "home_location": {
        "city": "London",
        "country": "UK",
        "location": "UK-HO-London",
        "name": "UK-HO-London",
        "postal_code": "56273",
        "state": "LND",
        "street_1": "1011",
        "street_2": "Lane number 4, Golden Villa"
      },
      "work_location": {
        "city": "London",
        "country": "UK",
        "location": "UK-HO-London",
        "name": "UK-HO-London",
        "postal_code": "56273",
        "state": "LND",
        "street_1": "1011",
        "street_2": "Lane number 4, Golden Villa"
      },
      "manager": "<any>",
      "pay_group": "<any>",
      "ssn": "1234567890",
      "gender": "MALE",
      "ethnicity": "ASIAN_OR_INDIAN_SUBCONTINENT",
      "marital_status": "SINGLE",
      "date_of_birth": "1986-10-27T00:00:00Z",
      "start_date": "2023-03-05T00:00:00Z",
      "remote_created_at": "2023-03-01T00:00:00Z",
      "employment_status": "INACTIVE",
      "termination_date": "2023-06-05T00:00:00Z",
      "avatar": "http://alturl.com/h2h8m",
      "payroll_run_calendar": "<any>"
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response