/employees/:id/documents

Time	Status	User Agent
Retrieving recent requests…

🚧
This particular endpoint uses r_employees scope, which can be enabled through the Integrations section found within the Settings menu. Account level tokens need member_id to work.

Results

Calling the /employees/:id/documents endpoint will return a collection of documents associated with an employee. An example of the response follows:

{
    "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",
          	"created_at": "2025-01-06T09:01:01.000Z",
						"updated_at": "2025-02-06T09:01:01.000Z"


        },
        {
            "id": "ddd",
            "filename": "Offer Letter.pdf",
            "filepath": "https://officedroid-hris.s3.amazonaws.com/uploads/1034258416/employee-documents/10986/ec6c9d6e-1835-4f47-b8b4-faae0142f26b",
            "filesize": 44009,
         		"created_by": "John Doe",
          	"created_at": "2025-01-06T09:01:01.000Z",
						"updated_at": "2025-02-06T09:01:01.000Z"

        }
    ]
}

Each employee_document will have the following keys:

key	type	description
id	`string`	Unique identifier for the document
filename	`string`	Name of the file/document
filepath	`string`	Complete URL where the file/document is hosted or stored. This is a signed AWS URL, with a TTL of 1 hour and can be used to download the respective file locally
filesize	`integer`	Size of the file in bytes
created_by	`string`	Name of the individual who uploaded or created the document
created_at	`string`	Timestamp of employee document creation
updated_at	`string`	Timestamp of employee document update

Document types

The optional type query parameter selects which class of document is returned:

type	description
`simple_employee_document` (default)	Uploaded employee documents
`signature_request_employee_document`	Signature request documents
`timeoff_attachment`	Files attached to time off requests
`i_9_form_document`	Completed I-9 form documents

I-9 form documents

type=i_9_form_document returns completed I-9 form documents and is only accessible to:

the employee who owns the document, or
a member with the SignaturesView permission.

Other callers receive 403 Forbidden.

The response payload for I-9 documents only includes filename, filepath, and filesize:

{
    "total_count": 1,
    "employee_documents": [
        {
            "filename": "I-9-form.pdf",
            "filepath": "https://officedroid-hris.s3.amazonaws.com/uploads/1034258416/employee-documents/10986/i-9-form.pdf",
            "filesize": 512
        }
    ]
}

This particular endpoint uses r_employees scope, which can be enabled through the Integrations section found within the Settings menu. Account level tokens need member_id to work.

Results

Document types

I-9 form documents

200200

400400

This particular endpoint uses `r_employees` scope, which can be enabled through the Integrations section found within the Settings menu. Account level tokens need `member_id` to work.