API Reference
API Reference

/employees/:id/documents

Uploads a list of documents for a specific employee. Required scope: w_employees.

🚧

This particular endpoint uses w_employees scope, which can be enabled through the Integrations section found within the Settings menu.

Body

{
    "documents": [
        {
            "url": "https://cdn.mos.cms.futurecdn.net/HjFE8NKWuCmgfHCcndJ3rK.jpg",
            "name": "Custom document"
        }
    ]
}
keytypedescription
urlstringComplete URL where the file/document is hosted or stored. TTL 1 hour
namestringName of the file/document

Calling the /employees/:id/documents POST endpoint will create a collection of documents associated with an employee.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!