GET
/
api
/
hris
/
v1
/
employees

Authorizations

Authorization
string
headerrequired

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

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_raw_data
boolean
default: false

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

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)

Response

200 - application/json
cursor
string | null
required

Cursor value to fetch next set of items

page_size
integer
required

Indicates the count of items in the response

items
object[]
required
Get Company By IdCreate Employee