Working with the Documents Tool

Overview

Procore’s powerful Documents tool provides robust and sophisticated document management and archiving for mission-critical project documentation. The Documents tool resources are accessible through the Procore API via the Company Folders and Files and Project Folders and Files endpoints.

Before You Begin

• Learn about Company Level Documents and Project Level Documents.
• Register for a Developer Account through the Procore Developer Portal.
• Gain an understanding of OAuth 2.0 and view our API Authentication endpoints.

Example Workflow for Documents Tool Integrations

This example lists the sequence of API calls for retrieving all project files.

• List Companies - GET /rest/v1.0/companies
• List Projects - GET /rest/v1.0/projects
• List Project Folders and Files - GET /rest/v1.0/folders
• Show Project Folder - GET /rest/v1.0/folders/{id}

Recursively fetch folders and files by calling the Show Project Folder endpoint on each previously returned folder. Repeat this step until all folders and files and been retrieved.

HELPFUL TIPS:

• To retrieve all Company files, use the Company Folders and Files endpoints.
• Use the Procore API to directly upload content to a storage service as this will help streamline uploads and reduce upload latency. See Working with Direct File Uploads for more information.
• Usage of Procore’s API is subject to rate limits. Procore API rate limits to 3,600 requests per hour. The rate limit resets every hour. See Rate Limiting to learn how to reduce the possibility of exceeding the rate limit. You can also use Webhooks to reduce the risk of exceeding Procore API Rate Limit caps.
• Refer to the User Permissions matrix for information on Documents tool permissions.
• Have Procore API questions? Contact our API Support team at apisupport@procore.com.