Skip to main content
GET
/
api
/
hris
/
v1
/
payroll-run-calendars
Get Payroll Run Calendars
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/payroll-run-calendars \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
import requests

url = "https://api.bindbee.dev/api/hris/v1/payroll-run-calendars"

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/payroll-run-calendars', 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/payroll-run-calendars",
  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/payroll-run-calendars"

	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/payroll-run-calendars")
  .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/payroll-run-calendars")

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"
      },
      "payroll_run_calendar_name": "Monthly Payroll Calendar",
      "pay_group": "018af1fe-2fad-749e-a282-ea17ba4fc0c4",
      "pay_period_start_date": "2023-11-01T00:00:00Z",
      "pay_period_end_date": "2023-11-30T00:00:00Z",
      "pay_date": "2023-12-05T00:00:00Z",
      "calendar_type": "MONTHLY",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      }
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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 the payroll run calendars to fetch

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"

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

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
HrisPayrollRunCalendar · object[]
required

List of items in the current response

Example:
{}