hris
group

List all groups

Changed on
get/hris/{connection_id}/group

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/group
  • Auth: API key in header authorization

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
parent_idstring
type'TEAM' | 'GROUP' | 'DEPARTMENT' | 'DIVISION' | 'BUSINESS_UNIT' | 'BRANCH' | 'SUB_DEPARTMENT' | 'PAY_GROUP'
user_idsstring[]
manager_idsstring[]
is_activeboolean
company_idstring

(reference to HrisCompany)

pay_frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'

pay cycle when type is PAY_GROUP

next_paid_atstring date-time

next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status