Group
Get Pay Group By Id
Returns a Group object with the given id.
GET
/
api
/
hris
/
v1
/
groups
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-connector-token
string
requiredPath Parameters
id
string
requiredQuery Parameters
include_raw_data
boolean
default: falseWhether to include the original data Bindbee fetched from the third-party to produce these models.
Response
200 - application/json
The Group object is used to represent a hierarchy in employees
id
string
requiredremote_id
string | null
requiredThe third-party API ID of the matching object.
modified_at
string
requiredThis is the datetime that this object was last updated by Bindbee
name
string | null
requiredThe group name.
type
string | null
requiredThe group type.
parent_group
string | null
requiredThe parent group id.
is_commonly_used_as_team
boolean | null
requiredThe group is commonly used as a team.
raw_data
object | null
This is the Raw data