Retrieve a group

Retrieves a single HrisGroup by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/hris/{connection_id}/group/{id}

Request

Base URL
https://api.unified.to
Auth
API key in header authorization
TypeScript
https://skmtc.dev/unified/apis/unified-to-api/docs/hris/:connection_id/group/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

connection_idstring required

ID of the connection

idstring required

ID of the Group

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

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

The name of the group (e.g. a team or department)

descriptionstring

parent_idstring

user_idsstring[]

manager_idsstring[]

is_activeboolean

company_idstring

(reference to HrisCompany)

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

Oct 19, 202639502239a975 Revision 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
Oct 8, 202607678e2ad542 Revision changes
- warning
  added the new PAY_GROUP enum value to the response property for the response status
- info
  added the enum value next_paid_at to the property items/ of the query request parameter fields
- info
  added the enum value pay_frequency to the property items/ of the query request parameter fields
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status