Company Folder And File Index
company_folder_and_file_indexList all folders and files in a Procore company document index. Query by folder, file type, date, or search to inspect company documents without modifying them.
Instructions
Return a list of all folders and files in the company. Use this when you already know which company folder and file index you want and need its full field set. company_id defaults to the value set by procore_set_config when omitted. Returns a single JSON object describing the company folder and file index. Read-only — it changes nothing in Procore. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: company_id. Procore API (v2.0): Core > Documents. Endpoint: GET /rest/v2.0/companies/{company_id}/documents
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| sort | No | Query string parameter — field to sort by. If the field is passed with a - (EX: -updated_at) it is sorted in reverse order | |
| view | No | Query string parameter — determines how much information to include in the response. `normal` is the default, `extended` provides additional data. The example below shows the `extended` response. | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| filters__search | No | Query string parameter — returns item(s) matching the specified search query string. | |
| filters__file_type | No | Query string parameter — return item(s) that have the file extensions | |
| filters__folder_id | No | Query string parameter — returns the folder for a given id with all subfolders and subfiles up to a depth of 100. Depths greater than 100 will need multiple queries to get all children. | |
| filters__created_at | No | Query string parameter — return item(s) created within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYYY-MM-... | |
| filters__updated_at | No | Query string parameter — return item(s) last updated within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYY... | |
| filters__created_by_id | No | Query string parameter — return item(s) created by the specified User IDs | |
| filters__document_type | No | Query string parameter — return item(s) that are file or folder | |
| filters__is_in_recycle_bin | No | Query string parameter — return item(s) that are in or not in the recycle bin |