Activity3

Application3

Attachment3

Bank Info2

Benefit Coverages2

Benefits2

Candidate5

Categories2

Company2

Compensation2

Completions2

Connector8

Contents2

Courses2

Custom Fields12

Department3

Dependent Benefits2

Dependents2

EEOC3

Employee5

Employee Payroll Runs4

Employer Benefits2

Employments2

Enrollments2

Group2

Health Check1

Integration3

Job3

Job Interview Stage3

Link1

Location2

Lookup2

Offer3

Office3

Passthrough1

Pay Groups2

Payroll Codes2

Payroll Run Calendars2

Payroll Runs2

Reject Reason3

Remote User3

Scheduled Interview3

Scorecard3

Screening Question3

Skills2

Tag3

Time Off4

Time Off Balance2

Timesheet Entry4

Users2

Webhooks3

Employee Payroll Runs

Get Employee Payroll Runs

Returns a list of EmployeePayrollRun objects.

get/api/hris/v1/employee-payroll-runs

Query parameters

idsstring nullable

The ID of the employee payroll runs to fetch

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

The ID of the employee payroll runs to fetch

employee_idstring nullable

The ID of the employees to fetch employee payroll run for

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

The ID of the employees to fetch employee payroll run for

payroll_run_idstring nullable

The IDs of the payroll runs to fetch employee payroll run for

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

The IDs of the payroll runs to fetch employee payroll run for

remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

include_raw_databoolean

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

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.

Whether to include custom fields in the response.

page_sizeinteger

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

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

cursorstring nullable

The pagination cursor value.

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

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.

start_date_fromstring nullable

If provided, only objects with start_date same or 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

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

start_date_tostring nullable

If provided, only objects with start_date same or before 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

If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

end_date_fromstring nullable

If provided, only objects with end_date same or 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

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

end_date_tostring nullable

If provided, only objects with end_date same or before 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

If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

check_date_fromstring nullable

If provided, only objects with check_date same or 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

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

check_date_tostring nullable

If provided, only objects with check_date same or before 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

If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

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.

Example:manager[first_name,last_name]

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.

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

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": "018b168d-70f9-7043-a796-56d66a4f8f07",
      "payroll_run": "018b709e-b6ef-7db4-902a-a064157bdba2",
      "start_date": "2023-07-01T00:00:00Z",
      "end_date": "2023-07-31T00:00:00Z",
      "check_date": "2023-08-31T00:00:00Z",
      "earnings": [
        {
          "name": "SALARY",
          "currency": "USD",
          "payroll_code": "019fbd01-e900-7418-a54c-3fcba1299e88"
        }
      ],
      "deductions": [
        {
          "name": "Social Security",
          "currency": "USD",
          "payroll_code": "019fbd01-e394-76ed-93fb-b9eda49a3b41"
        }
      ],
      "taxes": [
        {
          "name": "California State Income Tax",
          "currency": "USD",
          "payroll_code": "019fbd01-e5ea-7d5a-a602-bd9016a271cc"
        }
      ]
    }
  ]
}

Changes

Changed in 3 of the 11 revisions of this API.30

Aug 24, 2026a606b0cf18c920See the full diff
- ○
  query request parameter check_date_from list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter check_date_to list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter cursor list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter end_date_from list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter end_date_to list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter expand list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter modified_after list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter remote_id list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter start_date_from list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  query request parameter start_date_to list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  for the query request parameter check_date_from, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter check_date_to, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter cursor, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter end_date_from, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter end_date_to, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter expand, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter modified_after, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter remote_id, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter start_date_from, the type/format was generalized from string/ to /
  request-parameter-type-generalized
- ○
  for the query request parameter start_date_to, the type/format was generalized from string/ to /
  request-parameter-type-generalized
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 20266f24c7fcb3f86See the full diff
- ○
  added the optional property items/items/deductions/anyOf[subschema #1]/items/currency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/deductions/anyOf[subschema #1]/items/payroll_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/earnings/anyOf[subschema #1]/items/currency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/earnings/anyOf[subschema #1]/items/payroll_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/taxes/anyOf[subschema #1]/items/currency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/taxes/anyOf[subschema #1]/items/payroll_code to the response with the 200 status
  response-optional-property-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 1, 2026eb3486b88e554See the full diff
- ○
  added the new optional query request parameter ids
  new-optional-request-parameter
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added