GET
/
api
/
hris
/
v1
/
companies
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/companies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "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"
  },
  "legal_name": "Integrax Pvt. Ltd.",
  "display_name": "Bindbee",
  "eins": [
    "12-3456789",
    "12-3451111"
  ]
}

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

Path Parameters

​
id
string
required

Query Parameters

​
include_raw_data
boolean
default:
false

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

​
include_custom_fields
boolean
default:
false

Whether to include custom fields in the response.

Response

200
application/json
Successful Response

The Company object is used to represent a company within the HRIS / Payroll system.

​
id
string
required
​
remote_id
string | null
required

The third-party API ID of the matching object.

​
modified_at
string
required

This is the datetime that this object was last updated by Bindbee

​
custom_fields
object | null
required

The custom fields related to the model

​
legal_name
string | null
required

The company's legal name.

​
display_name
string | null
required

The company's display name.

​
eins
string[] | null
required

The company's Employer Identification Numbers.

​
raw_data
object | null

This is the Raw data

Get CompaniesGet Employees