GET /rest/v1.0/companies/{company_id}/documents

Return a list of all folders and files in the company

Servers

Path parameters

Name Type Required Description
company_id Integer Yes

Unique identifier for the company.

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
page Integer No

Page

filtersfile_type[] Array No

Return item(s) that have the file extensions

filterscreated_at String No

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-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset

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:

  • "document_type_then_name"
  • "name"
  • "document_type"
  • "document_type_then_updated_at"
  • "updated_at"
  • "document_type_then_created_at"
per_page Integer No

Elements per page

filtersupdated_at String No

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 YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00 - Datetime with Custom Offset

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

view String No

Determines how much information to include in the response. normal is the default, extended provides additional data. The example below shows the extended response.

Possible values:

  • "extended"
  • "normal"
filtersdocument_type String No

Return item(s) that are file or folder

Possible values:

  • "file"
  • "folder"
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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.