Return A List Of All Submittals.
return_a_list_of_all_submittalsRead-onlyIdempotent
Retrieve a paginated list of submittals from a Procore project. Filter by ID, status, date range, and more to get specific submittal data.
Instructions
Return a list of all Submittals. Use this to read information about Submittals from Procore. Returns a paginated JSON array of Submittals. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id, project_id. Procore API (v2.0): Project Management > Submittals. Endpoint: GET /rest/v2.0/companies/{company_id}/projects/{project_id}/submittals
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__anticipated_delivery_date | No | Query string parameter — array of dates (date range). Returns item(s) with their anticipated delivery date within the specified dates. A single date is also accepted. style: form | |
| filters__ball_in_court_id | No | Query string parameter — user ID. Return item(s) where the specified User ID is the Ball in Court. | |
| filters__ball_in_court_company_id | No | Query string parameter — company ID. Return item(s) where the specified Company ID is the Ball in Court. | |
| filters__closed_at | No | Query string parameter — return item(s) that are due 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_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__query | No | Query string parameter — return item(s) containing search query | |
| filters__received_from_id | No | Query string parameter — filter results by received from id | |
| filters__responsible_contractor_id | No | Query string parameter — return item(s) with the specified Responsible Contractor ID. | |
| filters__specification_section_id | No | Query string parameter — array of Specification Section IDs. A single Specification Section ID is also accepted. | |
| filters__approver_id | No | Query string parameter — array of User IDs. Return item(s) where the specified User IDs are in the approver list. A single integer is also accepted. | |
| filters__current_revision | No | Query string parameter — 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. | |
| filters__division | No | Query string parameter — array of Divisions to filter on. A Division is the first two digits from the Specification Section Number. A single Division is also accepted. | |
| filters__location_id | No | Query string parameter — array of Location IDs. A single Location ID is also accepted. | |
| filters__submittal_manager_id | No | Query string parameter — array of Submittal Manager IDs. A single Submittal Manager ID is also accepted. | |
| filters__submittal_package_id | No | Query string parameter — array of Submittal Package IDs. Returns item(s) associated with the specified Submittal Package IDs. A single integer value is also accepted. | |
| filters__response_id | No | Query string parameter — array of Response IDs. A single Response ID is also accepted. | |
| filters__status_id | No | Query string parameter — array of Status IDs. A single Status ID is also accepted. | |
| filters__type | No | Query string parameter — array of Submittal Types. A single Submittal Type is also accepted. | |
| 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__unpackaged | No | Query string parameter — parseable to boolean value, filters out unpackaged Submittals. | |
| filters__number | No | Query string parameter — array of Numbers. A single Number is also accepted. | |
| filters__has_operation_errors | No | Query string parameter — parseable to boolean value, filters Submittals based on whether they have operation errors from bulk operations. | |
| filters__operation_errors_by_operation_id | No | Query string parameter — filters Submittals that have operation errors associated with specific operation ID(s). Accepts single or multiple operation IDs. | |
| sort | No | Query string parameter — structure to sort submittal rows | |
| show_attachments | No | Query string parameter — determine the AttachmentVisible tag value(depend on configurable field set). |