v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Group

Get Group By Id

Returns a Group object with the given id.

get/api/hris/v1/groups/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

namestring nullable required

The group name.

type'COST_CENTER' | 'DEPARTMENT' | 'BUSINESS_UNIT' | 'DIVISION' | 'TEAM' nullable required

The group type.

parent_groupstring uuid nullable required

The parent group id.

is_commonly_used_as_teamboolean nullable required

The group is commonly used as a team.

Example response

{
  "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"
  },
  "name": "Engineering",
  "type": "DEPARTMENT",
  "parent_group": "018af1fe-1250-772d-87c5-6f725a579e8a",
  "is_commonly_used_as_team": true
}