--- title: "Get all submittals in project" method: GET path: "/api/v3/projects/{project_id}/submittals" tags: ["submittals"] --- # Get all submittals in project `GET /api/v3/projects/{project_id}/submittals` ## Path parameters - `project_id` string, uuid, required ## Query parameters - `last_synced_at` string, date-time - `filters[assignee_user_id_eq]` string - `filters[submittal_assignee_id_eq]` string - `filters[assignee_eq]` string - `filters[watched_by_eq]` string - `filters[action_required_by_eq]` string - `filters[status_eq]` string - `filters[spec_section_id_eq]` string - `filters[creator_pm_group_id_eq]` string - `filters[submittal_type_id_eq]` string - `filters[has_specification_eq]` string - `filters[submitting_pm_group_id_eq]` string - `filters[created_at_gte]` string - `filters[created_at_gt]` string - `filters[created_at_lte]` string - `filters[created_at_lt]` string - `filters[name_like]` string - `filters[name_eq]` string - `filters[updated_at_gte]` string - `filters[updated_at_gt]` string - `filters[updated_at_lte]` string - `filters[updated_at_lt]` string - `filters[query_like]` string - `filters[overdue_eq]` string ## Headers - `Fieldwire-Version` string, date, required - `Fieldwire-Filter` 'active' | 'deleted' - `Fieldwire-Per-Page` integer ## Response `200` Successful response - Submittal[] - `id` string, uuid, required — ID of the entity - `name` string, required — Name of the Submittal. Must be unique between Submittals under the same parent. - `description` string, nullable — Description of the Submittal - `number` integer, nullable — The number associated with the Submittal - `code` string, nullable — The code associated with the Submittal - `consolidated_current_number` string, nullable — The consolidated current number of the Submittal - `status` string, required — The status of the Submittal as an enum, e.g. draft, requested - `revision_number` integer, nullable — The revision number associated with the Submittal - `submit_by_date` string, date, nullable — The date the Submittal should be submitted by - `requested_at` string, date-time, nullable — Time when the server requested the entity - `submission_received_at` string, date-time, nullable — Time when the server submitted the entity - `response_received_at` string, date-time, nullable — Time at which the submittal was approved - `submitted_at` string, date-time, nullable — Time when the server submitted the entity - `responded_at` string, date-time, nullable — Time at which the submittal was approved - `assigned_at` string, date-time, nullable — Time when the server assigned the entity - `review_by_date` string, date, nullable — The date the Submittal should be reviewed by - `approve_by_date` string, date, nullable — The date the Submittal should be approved by - `reviewed_at` string, date-time, nullable — Time when the entity was reviewed - `approved_at` string, date-time, nullable — Time when the server approved the entity - `closed_at` string, date-time, nullable — Time when the server closed the entity - `voided_at` string, date-time, nullable — Time when the server voided the entity - `sent_for_approval_at` string, date-time, nullable — Time when the submittal was sent for approval - `response_time` integer, nullable — Difference between sent_for_approval_at and responded_at in days - `response` integer, nullable — The last primary approval response name, e.g. Approved, Rejected - `device_created_at` string, date-time — Time when the device created the entity - `device_updated_at` string, date-time — Time when the device last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `created_at` string, date-time, required — Time when the server created the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `spec_section_id` string, uuid, nullable — ID of the spec section the Submittal is associated with - `spec_section_project_resource_link` union - string, nullable — To allow null values - ProjectResourceLink — Entity that represents a Project Resource Link - `id` string, uuid, required — ID of the entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `entity_id_1` string, uuid, required — ID of the first entity to link - `entity_id_2` string, uuid, required — ID of the second entity to link - `target_entity_id` string, uuid, nullable — ID of the target entity - `entity_type_1` 'Rfi' | 'Sheet' | 'Task' | 'SpecSection' | 'Submittal' | 'ChangeOrder' | 'Form', required — The type of the first entity - `entity_type_2` 'Rfi' | 'Sheet' | 'Task' | 'SpecSection' | 'Submittal' | 'ChangeOrder' | 'Form', required — The type of the second entity - `data` object, nullable — JSON object that stores optional metadata of the entity - `device_created_at` string, date-time, nullable — Time when the device created the entity - `device_updated_at` string, date-time, nullable — Time when the device last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `created_at` string, date-time — Time when the server created the entity - `updated_at` string, date-time — Time when the server last updated the entity - `last_editor_user_id` integer, nullable — ID of the user who most recently edited this entity - `creator_user_id` integer, nullable — ID of the user who created this entity - `resolved_conflict` boolean — Specifies if PUT/PATCH request was rejected - do not store this field! - `submittal_type_id` string, uuid, nullable — ID of the type the Submittal is associated with - `submittal_type_name` string, nullable — Type name the Submittal is associated with - `spec_section` union - string, nullable — To allow null values - SpecSection — An entity that represents a spec section within a spec book. Can have multiple versions. - `id` string, uuid, required — ID of the spec_section - `section_number` string, required — The number that the spec_section corresponds to within a spec book - `project_id` string, uuid, required — ID of the project the spec_section belongs to - `current_version_id` string, uuid, nullable, required — ID of the current spec_section_version of the spec_section - `current_version_title` string, required — Title of the current spec_section_version of the spec_section - `current_version_description` string, required — Description of the spec_section_version of the spec_section - `current_version_file_url` string, nullable, required — The URL for the PDF associated with the current spec_section_version of the spec_section - `current_version_thumb_url` string, nullable, required — The URL for the thumbnail associated with the current spec_section_version of the spec_section - `conflict` boolean, required — Indicates a version conflict on the spec_section - `processing` boolean, required — Indicates the processing status of the spec_section - `error` boolean — Indicates whether the spec_section contains an error - `creator_user_id` integer, required — ID of the user who created the spec_section - `last_editor_user_id` integer, nullable, required — ID of the last user who edited the spec_section - `created_at` string, date-time, required — Time when the server created the spec_section - `updated_at` string, date-time, required — Time when the server last updated the spec_section - `deleted_at` string, date-time, nullable, required — Time when the server last deleted the spec_section - `device_created_at` string, date-time, required — Time when the device created the spec_section - `device_updated_at` string, date-time, required — Time when the device last updated the spec_section - `submittal_type` object — Entity that represents a Submittal Type - `id` string, uuid, required — ID of the entity - `name` string, required — Name of the entity - `translation_key` string, nullable — Translation key for the entity name - `aliases` string[], nullable — Alias names for entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `created_at` string, date-time, required — Time when the server created the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `deactivated_at` string, date-time, nullable — Time when the server last deactivated the entity - `submittal_actions` object[], nullable — Array containing submittal actions - `id` string, uuid, required — ID of the entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `assigned_at` string, date-time, nullable — Timestamp of when entity was assigned - `responded_at` string, date-time, nullable — Timestamp of when entity was responded to - `content` object, nullable — JSON object that stores the content of the entity - `message` string, nullable — Message associated with the entity - `outcome` string, required — The outcome of the entity as an enum, e.g. draft, requested - `revision_number` integer, required — The revision number associated with the entity - `device_created_at` string, date-time — Time when the device created the entity - `device_updated_at` string, date-time — Time when the device last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `submittal_id` string, uuid, required — ID of the submittal associated with the entity - `assignee_user_id` integer, nullable — The id of the user assigned to the entity - `submittal_assignee` SubmittalAssignee, nullable — the SubmittalAssignee - `id` string — unique identifier of the assignee - `email` string, nullable — if it is a non-user then the email of the non-user - `language` string, nullable — if it is a non-user then the language of the non-user - `kind` 'user' | 'non_user' — if it is a user or a non-user - `user_id` integer, nullable — if it is a user then the id of the User - `user` object, nullable — the associated project-user attributes - `user_id` integer — ID of the User. Belongs to User entity. - `full_name` string — User full name: first name + last name. - `project_id` string, uuid, nullable — The ID of the Project that project user belongs to. PmGroup information is scoped to this project. - `role` 'admin' | 'member' | 'follower' — role that the project-user holds in this project - `pm_group_id` string, uuid, nullable — The id of the PmGroup that user belongs to within a project. - `pm_group_name` string, nullable — The name of the PmGroup that user belongs to within a project. - `pm_role` 'contributor' | 'manager', nullable — project management role that the project-user holds in this project - `next_assignee_user_id` integer, nullable — The id of the user getting assigned to the next entity - `next_submittal_assignee` SubmittalAssignee, nullable — the SubmittalAssignee - `id` string — unique identifier of the assignee - `email` string, nullable — if it is a non-user then the email of the non-user - `language` string, nullable — if it is a non-user then the language of the non-user - `kind` 'user' | 'non_user' — if it is a user or a non-user - `user_id` integer, nullable — if it is a user then the id of the User - `user` object, nullable — the associated project-user attributes - `user_id` integer — ID of the User. Belongs to User entity. - `full_name` string — User full name: first name + last name. - `project_id` string, uuid, nullable — The ID of the Project that project user belongs to. PmGroup information is scoped to this project. - `role` 'admin' | 'member' | 'follower' — role that the project-user holds in this project - `pm_group_id` string, uuid, nullable — The id of the PmGroup that user belongs to within a project. - `pm_group_name` string, nullable — The name of the PmGroup that user belongs to within a project. - `pm_role` 'contributor' | 'manager', nullable — project management role that the project-user holds in this project - `responding_user_id` integer, nullable — The id of the user who responded to the entity - `created_at` string, date-time — Time when the server created the entity - `updated_at` string, date-time — Time when the server last updated the entity - `last_editor_user_id` integer, nullable — ID of the user who most recently edited this entity - `creator_user_id` integer, nullable — ID of the user who created this entity - `submittal_attachments` object[], nullable — Array containing submittal attachments - `id` string, uuid, required — ID of the Submittal Attachment object. - `name` string — Name of the file. - `file_url` string — URL of the potentially processed file - `kind` 'file', required — Kind of the attachment. Currently it only supports file type. - `submittal_id` string, uuid, required — The Submittal on which the attachment will exist. - `submittal_action_id` string, uuid, nullable — The Submittal Action on which the attachment will exist. - `project_id` string, uuid, required — ID of the project this entity belongs to - `last_editor_user_id` integer, required — ID of the user who last modified this entity - `creator_user_id` integer, required — ID of the user who created this entity - `created_at` string, date-time, required — Time when the server created the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `file_size` integer, nullable — Size of file - `original_url` string, nullable — URL of the file originally uploaded by the user - `flattened_file_url` string, nullable — URL of the file that has the markups flattened - `thumb_url` string, nullable — Thumb URL of the file - `attachment_id` string, uuid, nullable — The ID of the existing attachment. - `submittal_response_id` string, uuid, nullable — The ID of the existing response. - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time — Time when the device created the entity - `device_updated_at` string, date-time — Time when the device last updated the entity - `submittal_watchers` object[], nullable — Array containing submittal watchers - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer — ID of the user who last interacted modified this entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `user_id` integer, required — ID of the User being related. - `submittal_id` string, uuid, required — ID of the Submittal which is being related. - `user_name` string, nullable — Full name of the user who is watching this Submittal. - `user_email` string, nullable — Email of the user who is watching this Submittal. - `user_pm_group_id` string, nullable — PM Group ID of the user who is watching this Submittal. - `user_pm_group_name` string, nullable — Name of the PM Group of the user who is watching this Submittal. - `created_at` string, date-time, required — Time when the server created the entity - `device_created_at` string, date-time — Time when the device created the entity - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `device_updated_at` string, date-time — Time when the device last updated the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `reviewers` object[], nullable — Array containing meta data about reviewers - `name` string, required — Reviewers name - `company` string, nullable, required — Reviewers company - `responded` boolean, required — Whether or not the reviewer has responded - `primary_approver` boolean, required — Whether or not the reviewer is the primary approver - `project_id` string, uuid, required — ID of the project this entity belongs to - `creator_user_id` integer, required — ID of the user who created this entity - `creator_pm_group_id` string, uuid, nullable — The id of the PmGroup that the Submittal creator was in when the Submittal was created - `requesting_user_id` integer, nullable — The id of the user who requested the Submittal - `submitting_user_id` integer, nullable — The id of the user who submitted the Submittal - `submitting_pm_group_id` string, uuid, nullable — The id of the PmGroup that the Submittal submitting user was in when the Submittal was requested - `assignee_user_id` integer, nullable — The id of the user assigned to the Submittal - `submittal_assignee` SubmittalAssignee, nullable — the SubmittalAssignee - `id` string — unique identifier of the assignee - `email` string, nullable — if it is a non-user then the email of the non-user - `language` string, nullable — if it is a non-user then the language of the non-user - `kind` 'user' | 'non_user' — if it is a user or a non-user - `user_id` integer, nullable — if it is a user then the id of the User - `user` object, nullable — the associated project-user attributes - `user_id` integer — ID of the User. Belongs to User entity. - `full_name` string — User full name: first name + last name. - `project_id` string, uuid, nullable — The ID of the Project that project user belongs to. PmGroup information is scoped to this project. - `role` 'admin' | 'member' | 'follower' — role that the project-user holds in this project - `pm_group_id` string, uuid, nullable — The id of the PmGroup that user belongs to within a project. - `pm_group_name` string, nullable — The name of the PmGroup that user belongs to within a project. - `pm_role` 'contributor' | 'manager', nullable — project management role that the project-user holds in this project - `approving_user_id` integer, nullable — The id of the user who approved the Submittal - `closing_user_id` integer, nullable — The id of the user who closed the Submittal - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `creator_submittal_user` union - string, nullable — To allow null values - SubmittalUser — Entity that represents a SubmittalUser document - `id` string, uuid, required — ID of the entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `submittal_id` string, uuid, required — ID of the Submittal this entity belongs to - `submittal_revision_id` string, uuid — ID of the SubmittalRevision this entity belongs to - `project_userable_id` integer — ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind. - `project_userable_type` string — ProjectUser or ExternalProjectUser, i.e non-user or user kind - `user_id` integer, nullable — ID of the User. Belongs to User entity. - `revision_number` integer — SubmittalRevision number - `is_assignee` boolean, nullable — indication for whether this SubmittalUser is an assignee on the Submittal - `is_watcher` boolean, nullable — indication for whether this SubmittalUser is a watcher on the Submittal - `is_reviewer` boolean, nullable — indication for whether this SubmittalUser is a reviewer on the Submittal - `kind` string — kind of user - `email` string, nullable — users email, if non_user - `language` string, nullable — users language, if non_user - `user` object, nullable — the associated project-user attributes - `user_id` integer — ID of the User. Belongs to User entity. - `full_name` string — User full name: first name + last name. - `project_id` string, uuid, nullable — The ID of the Project that project user belongs to. PmGroup information is scoped to this project. - `role` 'admin' | 'member' | 'follower' — role that the project-user holds in this project - `pm_group_id` string, uuid, nullable — The id of the PmGroup that user belongs to within a project. - `pm_group_name` string, nullable — The name of the PmGroup that user belongs to within a project. - `pm_role` 'contributor' | 'manager', nullable — project management role that the project-user holds in this project - `device_created_at` string, date-time — Time when the device created the entity - `device_updated_at` string, date-time — Time when the device last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `created_at` string, date-time, required — Time when the server created the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `resolved_conflict` boolean — Specifies if PUT/PATCH request was rejected - do not store this field! - `closing_submittal_user` union - string, nullable — To allow null values - SubmittalUser — Entity that represents a SubmittalUser document - `id` string, uuid, required — ID of the entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `submittal_id` string, uuid, required — ID of the Submittal this entity belongs to - `submittal_revision_id` string, uuid — ID of the SubmittalRevision this entity belongs to - `project_userable_id` integer — ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind. - `project_userable_type` string — ProjectUser or ExternalProjectUser, i.e non-user or user kind - `user_id` integer, nullable — ID of the User. Belongs to User entity. - `revision_number` integer — SubmittalRevision number - `is_assignee` boolean, nullable — indication for whether this SubmittalUser is an assignee on the Submittal - `is_watcher` boolean, nullable — indication for whether this SubmittalUser is a watcher on the Submittal - `is_reviewer` boolean, nullable — indication for whether this SubmittalUser is a reviewer on the Submittal - `kind` string — kind of user - `email` string, nullable — users email, if non_user - `language` string, nullable — users language, if non_user - `user` object, nullable — the associated project-user attributes - `user_id` integer — ID of the User. Belongs to User entity. - `full_name` string — User full name: first name + last name. - `project_id` string, uuid, nullable — The ID of the Project that project user belongs to. PmGroup information is scoped to this project. - `role` 'admin' | 'member' | 'follower' — role that the project-user holds in this project - `pm_group_id` string, uuid, nullable — The id of the PmGroup that user belongs to within a project. - `pm_group_name` string, nullable — The name of the PmGroup that user belongs to within a project. - `pm_role` 'contributor' | 'manager', nullable — project management role that the project-user holds in this project - `device_created_at` string, date-time — Time when the device created the entity - `device_updated_at` string, date-time — Time when the device last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `created_at` string, date-time, required — Time when the server created the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `resolved_conflict` boolean — Specifies if PUT/PATCH request was rejected - do not store this field! - `voiding_submittal_user` union - string, nullable — To allow null values - SubmittalUser — Entity that represents a SubmittalUser document - `id` string, uuid, required — ID of the entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `submittal_id` string, uuid, required — ID of the Submittal this entity belongs to - `submittal_revision_id` string, uuid — ID of the SubmittalRevision this entity belongs to - `project_userable_id` integer — ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind. - `project_userable_type` string — ProjectUser or ExternalProjectUser, i.e non-user or user kind - `user_id` integer, nullable — ID of the User. Belongs to User entity. - `revision_number` integer — SubmittalRevision number - `is_assignee` boolean, nullable — indication for whether this SubmittalUser is an assignee on the Submittal - `is_watcher` boolean, nullable — indication for whether this SubmittalUser is a watcher on the Submittal - `is_reviewer` boolean, nullable — indication for whether this SubmittalUser is a reviewer on the Submittal - `kind` string — kind of user - `email` string, nullable — users email, if non_user - `language` string, nullable — users language, if non_user - `user` object, nullable — the associated project-user attributes - `user_id` integer — ID of the User. Belongs to User entity. - `full_name` string — User full name: first name + last name. - `project_id` string, uuid, nullable — The ID of the Project that project user belongs to. PmGroup information is scoped to this project. - `role` 'admin' | 'member' | 'follower' — role that the project-user holds in this project - `pm_group_id` string, uuid, nullable — The id of the PmGroup that user belongs to within a project. - `pm_group_name` string, nullable — The name of the PmGroup that user belongs to within a project. - `pm_role` 'contributor' | 'manager', nullable — project management role that the project-user holds in this project - `device_created_at` string, date-time — Time when the device created the entity - `device_updated_at` string, date-time — Time when the device last updated the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `created_at` string, date-time, required — Time when the server created the entity - `updated_at` string, date-time, required — Time when the server last updated the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `resolved_conflict` boolean — Specifies if PUT/PATCH request was rejected - do not store this field! - `submittal_code` string — The Submittal code - `resolved_conflict` boolean — Specifies if PUT/PATCH request was rejected - do not store this field! - `workflow` string — Determines which submittal transitions are available - `is_reminder_enabled` boolean — Boolean flag indicating if email reminders for submittals are enabled - `lead_time` integer, nullable — The number of weeks it takes to get the submittal material on-site after it is approved and closed (includes fabrication and shipping time) - `on_site_date` string, date, nullable — The first day in the construction schedule that the submittal's material is needed - `suggested_submit_by_date` string, date, nullable — The 'submit by' date calculated as optimal for ensuring the submittal will meet the on-site deadline (draft submittals only) - `message` string, nullable — Optional message to add onto body - `reference_number` string, nullable — Reference number of submittal --- [API](https://skmtc.dev/fieldwire/apis/fieldwire-super-api.md) · [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-super-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fieldwire/fieldwire-super-api/revisions/66ee1c20b92d/schema)