List Submittals On A Project
list_submittals_on_a_projectRead-onlyIdempotent
Retrieve a paginated list of submittals from a specified Procore project, with filtering by ID, status, location, and more. Use to find submittal IDs or generate overviews.
Instructions
Return a list of all Submittals from a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. See Downloading attachments with markup for information on downloading attachments with markup as a PDF. Use this to enumerate Submittals when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Submittals. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API (v1.1): Project Management > Submittals. Endpoint: GET /rest/v1.1/projects/{project_id}/submittals
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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__ball_in_court_id | No | Query string parameter — user ID. Return item(s) where the specified User ID is the Ball in Court. | |
| 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 — array of Responsible Contractor IDs. A single Responsible Contractor ID is also accepted. | |
| filters__required_on_site_date | No | Query string parameter — array of dates (date range). Returns item(s) with their required on site date withing the specified dates. A single date is also accepted. style: form | |
| 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__task_id | No | Query string parameter — array of Submittal Task IDs. Returns item(s) associated with the specified Submittal Task IDs. A single integer value is also accepted. | |
| 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 | |
| sort | No | Query string parameter — sort order for results. Prefix with '-' for descending order |