Sign in

v8

latestOpenAPI 3.0.02026-08-088001,2863.3 MB
hris
document

List all documents

get/hris/{connection_id}/document

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
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
document_urlstring
document_datastring
filenamestring
type'CONTRACT' | 'OFFER_LETTER' | 'POLICY' | 'TAX' | 'ID' | 'VISA' | 'PAYSLIP' | 'BENEFITS' | 'CERTIFICATION' | 'PERFORMANCE_REVIEW' | 'ONBOARDING' | 'TERMINATION' | 'MEDICAL' | 'OTHER'
user_idstring
company_idstring
rawobject