v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
hris
group

List all groups

get/hris/{connection_id}/group

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

company_idstring

The company ID to filter by (reference to HrisCompany)

typestring

The type to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
descriptionstring
parent_idstring
type'TEAM' | 'GROUP' | 'DEPARTMENT' | 'DIVISION' | 'BUSINESS_UNIT' | 'BRANCH' | 'SUB_DEPARTMENT'
user_idsstring[]
manager_idsstring[]
is_activeboolean
company_idstring
rawobject