v1
latestOpenAPI 3.1.02026-07-14801408.6 KB/employees/:id/documents
Returns a collection of the uploaded documents for a specific employee. Required scope: r_employees. Accessible with user level tokens and account level tokens that provide the member_id query param.
Use the type query parameter to select which class of documents to return. type=i_9_form_document is only accessible to the employee who owns the document or a member with the SignaturesView permission; other callers receive 403 Forbidden.
get/employees/{id}/documents
Path parameters
subdomainstring required
The account subdomain
idstring required
The employee id
Query parameters
member_idstring
Optional member id for user tokens. Required for account tokens. Members endpoint GET /members
type'simple_employee_document' | 'signature_request_employee_document' | 'timeoff_attachment' | 'i_9_form_document'
limitinteger
Limits the number of the returned results
offsetinteger
Skips the first n entries. Using limit and offset one can navigate through the entire employee database
Response
200
Example response
{
"total_count": 2,
"employee_documents": [
{
"id": "dde",
"filename": "Employee Handbook.pdf",
"filepath": "https://officedroid-hris.s3.amazonaws.com/uploads/1034258416/employee-documents/10986/10ee844d-61c3-4a07-b557-9e06f3c4f0dc",
"filesize": 60048,
"created_by": "John Doe"
}
]
}