hris
document

List all documents

get/hris/{connection_id}/document

Request

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

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

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

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
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)

type'CONTRACT' | 'OFFER_LETTER' | 'POLICY' | 'TAX' | 'ID' | 'VISA' | 'PAYSLIP' | 'BENEFITS' | 'CERTIFICATION' | 'PERFORMANCE_REVIEW' | 'ONBOARDING' | 'TERMINATION' | 'MEDICAL' | 'OTHER'
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)

document_urlstring

download link, expires after 1 hour

document_datastring

base64 encoded file contents for create/update

filenamestring
type'CONTRACT' | 'OFFER_LETTER' | 'POLICY' | 'TAX' | 'ID' | 'VISA' | 'PAYSLIP' | 'BENEFITS' | 'CERTIFICATION' | 'PERFORMANCE_REVIEW' | 'ONBOARDING' | 'TERMINATION' | 'MEDICAL' | 'OTHER'

unified, normalized document type (OTHER when unmappable)

user_idstring

pointer to the HR Employee object that owns this document (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.