Pagination

Get Employees

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

import requests

url = "https://api.bindbee.dev/api/hris/v1/employees"

headers = {
    "x-connector-token": "<x-connector-token>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-connector-token': '<x-connector-token>', Authorization: 'Bearer <token>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/employees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/employees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-connector-token: <x-connector-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/employees"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-connector-token", "<x-connector-token>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/employees")
  .header("x-connector-token", "<x-connector-token>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 123,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "remote_id": "123321",
      "modified_at": "<string>",
      "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"
      },
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "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": {
        "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": "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"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

api

hris

employees

Get Employees

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

import requests

url = "https://api.bindbee.dev/api/hris/v1/employees"

headers = {
    "x-connector-token": "<x-connector-token>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-connector-token': '<x-connector-token>', Authorization: 'Bearer <token>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/employees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/employees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-connector-token: <x-connector-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/employees"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-connector-token", "<x-connector-token>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/employees")
  .header("x-connector-token", "<x-connector-token>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 123,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "remote_id": "123321",
      "modified_at": "<string>",
      "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"
      },
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "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": {
        "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": "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"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Overview

Any data you interact with via the Bindbee API can be paginated, and this pagination is determined by the cursor and page_size query parameters.

Sample HTTP Request

Above is an example of an interactive HTTP request using the Bindbee API to demonstrate how pagination works:

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

ids

string | null

The ID of employees to fetch

Example:

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

manager_id

string | null

The ID of managers to fetch employees for

Example:

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

remote_id

string

The third-party API ID of the matching object.

Example:

"3235005483341316245"

company_id

string | null

The ID of companies to fetch employees for

Example:

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

include_raw_data

boolean

default:false

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

Example:

false

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

Example:

false

employment_status

enum<string>

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

Available options:

ACTIVE,

PENDING,

INACTIVE,

ACTIVE_EXTERNAL,

INACTIVE_EXTERNAL,

-,

LEAVE,

DECEASED,

RETIRED

Example:

"ACTIVE"

employee_number

string

If provided, will only return employees for this employee number

Example:

"000000168"

groups

string | null

The ID of groups to fetch employees for

Example:

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

pay_group_id

string | null

The ID of pay groups to fetch employees for

Example:

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

page_size

integer

default:50

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

Required range: 1 <= x <= 200

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)

Example:

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

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.

Example:

"manager[first_name,last_name]"

Response

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

HrisEmployeeResponse · object[]

required

List of items in the current response

Show child attributes

Example:

{}

Authentication

Sync Frequency

Bindbee API Basics

Connectors

Integrations

Supplemental Data

Overview

Sample HTTP Request

Authorizations

Headers

Query Parameters

Response

​Overview

​Sample HTTP Request

Authorizations

Headers

Query Parameters

Response

Overview

Sample HTTP Request