Sign in
hris
timeoff

List all timeoffs

get/hris/{connection_id}/timeoff

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

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

company_idstring

The company ID to filter by (reference to HrisCompany)

typestring
start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

statusstring
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
user_idstring required
company_idstring
start_atstring date-time
end_atstring date-time
is_paidboolean
status'APPROVED' | 'PENDING' | 'DENIED' | 'CANCELLED'
approver_user_idstring
approved_atstring date-time
commentsstring
reasonstring
original_typestring
type'VACATION' | 'SICK' | 'HOLIDAY' | 'BEREAVEMENT' | 'PARENTAL' | 'UNPAID' | 'IN_LIEU' | 'OTHER'
durationnumber
duration_type'HOUR' | 'DAY'
rawobject

Changes

Changed in 3 of the 34 revisions of this API.13

  • 88010aaae74e2See the full diff
    • ○

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

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • aeeac8203aca1See the full diff
    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

  • 6f28006e0c631See the full diff
    • ●

      added the new CANCELLED enum value to the / response property for the response status

      response-property-enum-value-added