Activity3

Application3

Attachment3

Bank Info2

Benefit Coverages2

Benefits2

Candidate5

Categories2

COBRA Events2

Company2

Compensation2

Completions2

Connector8

Contents2

Courses2

Custom Fields12

Department3

Dependent Benefits2

Dependents2

EEOC3

Employee5

Employee Payroll Runs4

Employee Skills2

Employer Benefits2

Employments2

Enrollments2

Group2

Health Check1

Integration3

Job3

Job Interview Stage3

Learning Skills2

Link1

Location2

Lookup2

Offer3

Office3

Passthrough1

Pay Groups2

Payroll Codes2

Payroll Run Calendars2

Payroll Runs2

Performance Review Items2

Performance Reviews2

Reject Reason3

Remote User3

Scheduled Interview3

Scorecard3

Screening Question3

Skills2

Tag3

Time Off4

Time Off Balance2

Timesheet Entry4

Users2

Webhooks3

Employee

Get Employees

Changed on Oct 19, 2026

Returns a list of Employee objects.

get/api/hris/v1/employees

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

Query parameters

idsstring nullable

The ID of employees to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

manager_idstring nullable

The ID of managers to fetch employees for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245

company_idstring nullable

The ID of companies to fetch employees for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

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.

employment_statusstring nullable

If provided, will only return employees with this employment status. Along with the standard values, any connector specific value returned in the response can be passed as well. Pass several values, comma-separated, to match any of them.

Example:ACTIVE

employee_numberstring nullable

If provided, will only return employees for this employee number

Example:000000168

first_namestring nullable

If provided, will only return employees with this first name (case-insensitive)

Example:Jane

last_namestring nullable

If provided, will only return employees with this last name (case-insensitive)

Example:Doe

work_emailstring nullable

If provided, will only return employees with this work email (case-insensitive)

Example:jane.doe@acme.com

groupsstring nullable

The ID of groups to fetch employees for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

work_locationsstring nullable

The ID of locations to fetch employees for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

pay_group_idstring nullable

The ID of pay groups to fetch employees for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

payroll_run_calendar_idstring nullable

The ID of payroll run calendars to fetch employees for

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

page_sizeinteger

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

cursorstring nullable

The pagination cursor value.

modified_afterstring nullable

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

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

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example response

{
  "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": "018af1fe-1250-772d-87c5-6f725a579e8a",
      "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": [
        "018af1fe-1250-772d-87c5-6f725a579e8a",
        "018af1fe-1250-772d-87c5-6f725a579e8b"
      ],
      "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": {
        "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"
      },
      "work_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"
      },
      "work_locations": [
        "018af1fe-1250-772d-87c5-6f725a579e8a",
        "018af1fe-1250-772d-87c5-6f725a579e8b"
      ],
      "manager": "018aeaff-cc7c-7837-988a-965762bd63c1",
      "pay_group": "018af1fe-1250-77c5-9fcd-4bca1e4568f4",
      "ssn": "1234567890",
      "gender": "MALE",
      "ethnicity": "ASIAN_OR_INDIAN_SUBCONTINENT",
      "marital_status": "SINGLE",
      "tobacco_use": true,
      "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",
      "termination_reason": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "avatar": "http://alturl.com/h2h8m",
      "payroll_run_calendar": "018af1fe-1250-77c5-9fcd-4bca1e4568f4",
      "employment_type": "FULL_TIME"
    }
  ]
}

Changes

Oct 19, 2026161f45ea60df Revision changes
- info
  added the new optional query request parameter payroll_run_calendar_id
Oct 6, 20261f9bc0ad4bfb Revision 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
  added the optional property // to the response with the status
- info
  removed the - enum value from the // response property for the response status
- info
  removed the - enum value from the // response property for the response status
- info
  removed the - enum value from the // response property for the response status
- info
  removed the - enum value from the // response property for the response status
- info
  removed the ACTIVE enum value from the // response property for the response status
- info
  removed the ACTIVE_EXTERNAL enum value from the // response property for the response status
- info
  removed the AMERICAN_INDIAN_OR_ALASKA_NATIVE enum value from the // response property for the response status
- info
  removed the ASIAN_OR_INDIAN_SUBCONTINENT enum value from the // response property for the response status
- info
  removed the BLACK_OR_AFRICAN_AMERICAN enum value from the // response property for the response status
- info
  removed the CIVIL_PARTNERSHIP enum value from the // response property for the response status
- info
  removed the COMMON_LAW enum value from the // response property for the response status
- info
  removed the DECEASED enum value from the // response property for the response status
- info
  removed the DIVORCED enum value from the // response property for the response status
- info
  removed the DOMESTIC_PARTNERSHIP 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 HEAD_OF_HOUSEHOLD enum value from the // response property for the response status
- info
  removed the HISPANIC_OR_LATINO enum value from the // response property for the response status
- info
  removed the INACTIVE enum value from the // response property for the response status
- info
  removed the INACTIVE_EXTERNAL enum value from the // response property for the response status
- info
  removed the IN_A_RELATIONSHIP enum value from the // response property for the response status
- info
  removed the LEAVE 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 MARRIED enum value from the // response property for the response status
- info
  removed the NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER 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 OTHER 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 PENDING 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 PREFER_NOT_TO_DISCLOSE enum value from the // response property for the response status
- info
  removed the QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD enum value from the // response property for the response status
- info
  removed the RETIRED enum value from the // response property for the response status
- info
  removed the SEPARATED enum value from the // response property for the response status
- info
  removed the SINGLE enum value from the // response property for the response status
- info
  removed the TWO_OR_MORE_RACES enum value from the // response property for the response status
- info
  removed the WHITE enum value from the // response property for the response status
- info
  removed the WIDOWED enum value from the // response property for the response status

Operation history (8 revisions)

Get Employees

Request

Query parameters

Response 200OK

Example response

Changes

Response