GET /rest/v2.0/companies/{company_id}/projects/{project_id}/submittals
Return a list of all Submittals.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_id |
String | Yes |
Unique identifier for the project. |
company_id |
String | 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 |
---|---|---|---|
filtersdivision[] |
Array | No |
Array of Divisions to filter on. A Division is the first two digits from the Specification Section Number. A single Division is also accepted. |
filtersball_in_court_company_id |
String | No |
Company ID. Return item(s) where the specified Company ID is the Ball in Court. |
filterssubmittal_manager_id[] |
Array | No |
Array of Submittal Manager IDs. A single Submittal Manager ID is also accepted. |
filterssubmittal_package_id[] |
Array | No |
Array of Submittal Package IDs. Returns item(s) associated with the specified Submittal Package IDs. A single integer value is also accepted. |
filterscurrent_revision[] |
Array | No |
Default false. If true, only current revisions are shown. If false, all submittals are shown, regardless of whether or not it is the current revision. |
filtersupdated_at |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
filtersball_in_court_id |
String | No |
User ID. Return item(s) where the specified User ID is the Ball in Court. |
filterstype[] |
Array | No |
Array of Submittal Types. A single Submittal Type is also accepted. |
filterscreated_at |
String | No |
Return item(s) created within the specified ISO 8601 datetime range.
Formats:
|
filtersnumber[] |
Array | No |
Array of Numbers. A single Number is also accepted. |
sort |
String | No |
Structure to sort submittal rows Possible values:
|
filtersresponsible_contractor_id |
String | No |
Return item(s) with the specified Responsible Contractor ID. |
filterslocation_id[] |
Array | No |
Array of Location IDs. A single Location ID is also accepted. |
page |
Integer | No |
Page |
filtersreceived_from_id[] |
Array | No |
Received From ID |
filtersstatus_id[] |
Array | No |
Array of Status IDs. A single Status ID is also accepted. |
filtersunpackaged[] |
Array | No |
Parseable to boolean value, filters out unpackaged Submittals. |
filtersapprover_id[] |
Array | No |
Array of User IDs. Return item(s) where the specified User IDs are in the approver list. A single integer is also accepted. |
per_page |
Integer | No |
Elements per page Default value: 10 |
filtersspecification_section_id[] |
Array | No |
Array of Specification Section IDs. A single Specification Section ID is also accepted. |
filtersresponse_id[] |
Array | No |
Array of Response IDs. A single Response ID is also accepted. |
filtersid[] |
Array | No |
Return item(s) with the specified IDs. |
filtersclosed_at |
String | No |
Return item(s) that are due within the specified ISO 8601 datetime range.
Formats:
|
filtersquery |
String | No |
Return item(s) containing search query |
show_attachments |
Boolean | No |
Determine the AttachmentVisible tag value(depend on configurable field set). |
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.