The Docs API provides access to the details of your company documents and folders.
Getting started
Before you start, explore the Docs API to learn how to upload and access Bob's documents via the Public API.
File Size Limits
- General uploads: Files can be uploaded up to a maximum size of 5MB.
- Uploads to custom folders: When uploading to a custom folder, the size limit is 1MB. This limitation is relevant to the following endpoints:
Permissions required
Each docs folder (e.g., Shared, Confidential, or a custom folder) has its permissions managed separately in a permission section with the folder name.
To access documents via the API, you should grant the service user permissions based on the folders you want to access and the actions you want to perform.
| Action | Permission |
|---|---|
| Download documents | People's Data > Docs > [docs folder] > View selected employees' docs in the folder. |
| Upload documents | People's Data > Docs > [docs folder] > Upload selected employees’ docs in the folder. |
| Delete documents | People's Data > Docs > [docs folder] > Delete selected employees’ docs in the folder |
For example, for a custom folder called "Recruitment CVs", you need to set the permission:
People's Data > Docs > Recruitment CVs > View selected employees' docs in the folder.
To learn more, see Permissions.
Rate limiting
At the moment, document endpoints don't have rate limits.