GET /rest/v1.0/projects/{project_id}/documents
Return a list of all folders and files in the project
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
filterscreated_at |
String | No |
Return item(s) created within the specified ISO 8601 datetime range.
Formats:
|
sort |
String | No |
Field to sort by. If the field is passed with a - (EX: -updated_at) it is sorted in reverse order Possible values:
|
view |
String | No |
Determines how much information to include in the response. Possible values:
|
filtersfolder_id |
Integer | No |
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. |
page |
Integer | No |
Page |
filtersfile_type[] |
Array | No |
Return item(s) that have the file extensions |
per_page |
Integer | No |
Elements per page |
filtersprivate |
Boolean | No |
If true, returns only item(s) with a |
filtersupdated_at |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
filterssearch |
String | No |
Return item(s) that contain string in document name and file description |
filtersis_in_recycle_bin |
Boolean | No |
Return item(s) that are in or not in the recycle bin |
filterscreated_by_id[] |
Array | No |
Return item(s) created by the specified User IDs |
filterscustom_tag_ids[] |
Array | No |
Return item(s) with specified custom tag IDs |
filtersdocument_type |
String | No |
Return item(s) that are file or folder Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.