6f24c7fcb3f8
Get Employees
Returns a list of Employee objects.
Query parameters
The ID of employees to fetch
The ID of employees to fetch
The ID of managers to fetch employees for
The ID of managers to fetch employees for
The third-party API ID of the matching object.
The third-party API ID of the matching object.
The ID of companies to fetch employees for
The ID of companies to fetch employees for
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.
Whether to include custom fields in the response.
Whether to include custom fields in the response.
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.
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.
If provided, will only return employees for this employee number
If provided, will only return employees for this employee number
If provided, will only return employees with this first name (case-insensitive)
If provided, will only return employees with this first name (case-insensitive)
If provided, will only return employees with this last name (case-insensitive)
If provided, will only return employees with this last name (case-insensitive)
If provided, will only return employees with this work email (case-insensitive)
If provided, will only return employees with this work email (case-insensitive)
The ID of groups to fetch employees for
The ID of groups to fetch employees for
The ID of locations to fetch employees for
The ID of locations to fetch employees for
The ID of pay groups to fetch employees for
The ID of pay groups to fetch employees for
Number of results to return per page. Maximum size is 200.
Number of results to return per page. Maximum size is 200.
The pagination cursor value.
The pagination cursor value.
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.
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.
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.
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
Response
Successful 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_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"
}
]
}