Submittals
- GET
/rest/v1.0/companies/{company_id}/submittal_statusesList Submittal Statuses - PATCH
/rest/v1.0/projects/{project_id}/submittal_logs/{id}/close_and_distributeClose a submittal log and distribute it - GET
/rest/v1.0/projects/{project_id}/submittal_packages - POST
/rest/v1.0/projects/{project_id}/submittal_packages - GET
/rest/v1.0/projects/{project_id}/submittal_packages/{id} - PATCH
/rest/v1.0/projects/{project_id}/submittal_packages/{id} - POST
/rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittals - DELETE
/rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittals - GET
/rest/v1.0/projects/{project_id}/submittal_workflow_templatesList submittal workflow templates - POST
/rest/v1.0/projects/{project_id}/submittal_workflow_templatesCreate a submittal workflow template - GET
/rest/v1.0/projects/{project_id}/submittals/filter_options/ball_in_court_idList Filter Options for Ball in Court - GET
/rest/v1.0/projects/{project_id}/submittals/filter_options/responsible_contractor_idList Filter Options for Responsible Contractor - GET
/rest/v1.0/projects/{project_id}/submittals/filter_options/status_idList Filter Options for Submittal Status - PATCH
/rest/v1.0/submittal_approvers/{id}Update Submittal Approver - GET
/rest/v1.1/projects/{project_id}/submittalsList Submittals on a project - POST
/rest/v1.1/projects/{project_id}/submittalsCreate Submittal - GET
/rest/v1.1/projects/{project_id}/submittals/{id}Show Submittal - PATCH
/rest/v1.1/projects/{project_id}/submittals/{id}Update Submittal - DELETE
/rest/v1.1/projects/{project_id}/submittals/{id}Delete Submittal - GET
/rest/v1.1/projects/{project_id}/submittals/{id}/revisionsList a submittal's revisions - POST
/rest/v1.1/projects/{project_id}/submittals/{id}/revisionsCreate a new revision of a submittal - GET
/rest/v1.1/projects/{project_id}/submittals/recycle_binList of deleted Submittals
/rest/v1.0/companies/{company_id}/submittal_statusesList Submittal Statuses
Parameters
- OS-Company-Idintegerheaderrequired
- company_idintegerpathrequired
- pageintegerquery
- per_pageintegerquery
Response · 200 · object[]
- idinteger
- namestring
- statusstring
- is_defaultboolean
/rest/v1.0/projects/{project_id}/submittal_logs/{id}/close_and_distributeClose a submittal log and distribute it
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object
- actual_delivery_datestring (date)
- attachmentsobject[]
- confirmed_delivery_datestring (date)
- cost_codeobject
- created_atstring (date-time)
- custom_textarea_1string
- custom_textfield_1string
- deleted_atstring (date-time)
- rich_text_descriptionstring
- design_team_review_timeinteger
- distribution_membersobject[]
- internal_review_timeinteger
- lead_timeinteger
- required_on_site_datestring (date)
- scheduled_taskobject
- source_submittal_log_idinteger
- distributed_submittalsobject[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- operation_item_errorsobject[]
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- ball_in_courtobject[]
- buffer_timeinteger
- prepare_timeinteger
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- idinteger
- numberstring
- revisionstring
- titlestring
/rest/v1.0/projects/{project_id}/submittal_packagesGET projects/{project_id}/submittal_packages
Parameters
- project_idstringpathrequired
Response · 200 · object[]
- idintegerrequired
- numberstringrequired
- titlestringrequired
- statusobject
- specification_section_idinteger
- specification_section_idsinteger[]
- distribution_member_idsinteger[]
- distribution_membersobject[]
- created_byobject
- attachmentsobject[]
- attachments_countinteger
- submittal_idsinteger[]required
- updated_atstringrequired
- created_atstring
/rest/v1.0/projects/{project_id}/submittal_packagesPOST projects/{project_id}/submittal_packages
Parameters
- project_idstringpathrequired
Response · 201 · object
- idintegerrequired
- numberstringrequired
- titlestringrequired
- statusobject
- specification_section_idinteger
- specification_section_idsinteger[]
- distribution_member_idsinteger[]
- distribution_membersobject[]
- created_byobject
- attachmentsobject[]
- attachments_countinteger
- submittal_idsinteger[]required
- updated_atstringrequired
- created_atstring
/rest/v1.0/projects/{project_id}/submittal_packages/{id}GET projects/{project_id}/submittal_packages/{id}
Parameters
- project_idstringpathrequired
- idstringpathrequired
Response · 200 · object
- idintegerrequired
- numberstringrequired
- titlestringrequired
- statusobject
- specification_section_idinteger
- specification_section_idsinteger[]
- distribution_member_idsinteger[]
- distribution_membersobject[]
- created_byobject
- attachmentsobject[]
- attachments_countinteger
- submittal_idsinteger[]required
- updated_atstringrequired
- created_atstring
/rest/v1.0/projects/{project_id}/submittal_packages/{id}PATCH projects/{project_id}/submittal_packages/{id}
Parameters
- project_idstringpathrequired
- idstringpathrequired
Response · 200 · object
- idintegerrequired
- numberstringrequired
- titlestringrequired
- statusobject
- specification_section_idinteger
- specification_section_idsinteger[]
- distribution_member_idsinteger[]
- distribution_membersobject[]
- created_byobject
- attachmentsobject[]
- attachments_countinteger
- submittal_idsinteger[]required
- updated_atstringrequired
- created_atstring
/rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittalsPOST projects/{project_id}/submittal_packages/{id}/submittals
Parameters
- project_idstringpathrequired
- idstringpathrequired
Response · 200 · object
- idintegerrequired
- numberstringrequired
- titlestringrequired
- statusobject
- specification_section_idinteger
- specification_section_idsinteger[]
- distribution_member_idsinteger[]
- distribution_membersobject[]
- created_byobject
- attachmentsobject[]
- attachments_countinteger
- submittal_idsinteger[]required
- updated_atstringrequired
- created_atstring
/rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittalsDELETE projects/{project_id}/submittal_packages/{id}/submittals
Parameters
- project_idstringpathrequired
- idstringpathrequired
Response · 200 · object
- idintegerrequired
- numberstringrequired
- titlestringrequired
- statusobject
- specification_section_idinteger
- specification_section_idsinteger[]
- distribution_member_idsinteger[]
- distribution_membersobject[]
- created_byobject
- attachmentsobject[]
- attachments_countinteger
- submittal_idsinteger[]required
- updated_atstringrequired
- created_atstring
/rest/v1.0/projects/{project_id}/submittal_workflow_templatesList submittal workflow templates
Parameters
- project_idintegerpathrequired
Response · 200 · object[]
- idinteger
- namestring
- is_defaultboolean
- created_atstring (date-time)
- updated_atstring (date-time)
- stepsobject[]
/rest/v1.0/projects/{project_id}/submittal_workflow_templatesCreate a submittal workflow template
Parameters
- project_idintegerpathrequired
Response · 201 · object
- idinteger
- namestring
- is_defaultboolean
- created_atstring (date-time)
- updated_atstring (date-time)
- stepsobject[]
/rest/v1.0/projects/{project_id}/submittals/filter_options/ball_in_court_idList Filter Options for Ball in Court
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- pageintegerquery
- per_pageintegerquery
Response · 200 · object[]
- keyinteger
- valuestring
/rest/v1.0/projects/{project_id}/submittals/filter_options/responsible_contractor_idList Filter Options for Responsible Contractor
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- pageintegerquery
- per_pageintegerquery
Response · 200 · object[]
- keyinteger
- valuestring
/rest/v1.0/projects/{project_id}/submittals/filter_options/status_idList Filter Options for Submittal Status
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- pageintegerquery
- per_pageintegerquery
Response · 200 · object[]
- keyinteger
- valuestring
/rest/v1.0/submittal_approvers/{id}Update Submittal Approver
Parameters
- OS-Company-Idintegerheaderrequired
- idintegerpathrequired
- project_idintegerqueryrequired
- send_emailsbooleanquery
- submittal_idintegerqueryrequired
Request body
- submittal_approverobject
Response · 200 · object
- idinteger
- attachmentsobject[]
- commentstring
- returned_datestring (date)
- sent_datestring (date)
- email_sent_atstring (date-time)
- days_to_respondinteger | null
- submittal_response_idinteger
/rest/v1.1/projects/{project_id}/submittalsList Submittals on a project
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- pageintegerquery
- per_pageintegerquery
- filters[id]integer[]query
- filters[ball_in_court_id]integerquery
- filters[created_at]string (date)query
- filters[query]stringquery
- filters[received_from_id]integerquery
- filters[responsible_contractor_id]integer[]query
- filters[required_on_site_date]string (date)[]query
- filters[specification_section_id]integer[]query
- filters[approver_id]integer[]query
- filters[current_revision]booleanquery
- filters[division]integer[]query
- filters[location_id]integer[]query
- filters[submittal_manager_id]integer[]query
- filters[submittal_package_id]integer[]query
- filters[response_id]integer[]query
- filters[status_id]integer[]query
- filters[type]string[]query
- filters[updated_at]string (date)query
- filters[unpackaged]booleanquery
- filters[number]string[]query
- filters[task_id]integer[]query
- filters[anticipated_delivery_date]string (date)[]query
- sortstringquery
Response · 200 · object[]
- idinteger
- numberstring
- formatted_numberstring
- titlestring
- revisionstring
- current_revisionboolean
- privateboolean
- created_atstring (date-time)
- updated_atstring (date-time)
- due_datestring (date)
- issue_datestring (date)
- received_datestring (date)
- submit_bystring (date)
- actual_delivery_datestring (date)
- required_on_site_datestring (date)
- distributed_atstring (date-time)
- closed_atstring (date-time)
- submittal_workflow_template_applied_atstring (date-time)
- lead_timeinteger
- location_idinteger
- cost_code_idinteger
- sub_job_idinteger
- created_byobject
- received_fromobject
- submittal_managerobject
- responsible_contractorobject
- distribution_membersobject[]
- ball_in_courtobject[]
- statusobject
- typeobject
- specification_sectionobject
- submittal_workflow_templateobject
- drawing_idsinteger[]
- linked_drawing_idsinteger[]
- associated_attachmentsobject[]
- approversobject[]
- last_distributed_submittalobject
- submittal_packageobject
- scheduled_taskobject
- custom_fieldsobject
/rest/v1.1/projects/{project_id}/submittalsCreate Submittal
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- send_emailsbooleanquery
Request body
- submittalobject
Response · 201 · object
- actual_delivery_datestring (date)
- attachmentsobject[]
- confirmed_delivery_datestring (date)
- cost_codeobject
- created_atstring (date-time)
- custom_textarea_1string
- custom_textfield_1string
- deleted_atstring (date-time)
- rich_text_descriptionstring
- design_team_review_timeinteger
- distribution_membersobject[]
- internal_review_timeinteger
- lead_timeinteger
- required_on_site_datestring (date)
- scheduled_taskobject
- source_submittal_log_idinteger
- distributed_submittalsobject[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- operation_item_errorsobject[]
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- ball_in_courtobject[]
- buffer_timeinteger
- prepare_timeinteger
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- idinteger
- numberstring
- revisionstring
- titlestring
/rest/v1.1/projects/{project_id}/submittals/{id}Show Submittal
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object
- actual_delivery_datestring (date)
- attachmentsobject[]
- confirmed_delivery_datestring (date)
- cost_codeobject
- created_atstring (date-time)
- custom_textarea_1string
- custom_textfield_1string
- deleted_atstring (date-time)
- rich_text_descriptionstring
- design_team_review_timeinteger
- distribution_membersobject[]
- internal_review_timeinteger
- lead_timeinteger
- required_on_site_datestring (date)
- scheduled_taskobject
- source_submittal_log_idinteger
- distributed_submittalsobject[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- operation_item_errorsobject[]
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- ball_in_courtobject[]
- buffer_timeinteger
- prepare_timeinteger
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- idinteger
- numberstring
- revisionstring
- titlestring
/rest/v1.1/projects/{project_id}/submittals/{id}Update Submittal
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- idintegerpathrequired
- send_emailsbooleanquery
Request body
- submittalobject
Response · 200 · object
- actual_delivery_datestring (date)
- attachmentsobject[]
- confirmed_delivery_datestring (date)
- cost_codeobject
- created_atstring (date-time)
- custom_textarea_1string
- custom_textfield_1string
- deleted_atstring (date-time)
- rich_text_descriptionstring
- design_team_review_timeinteger
- distribution_membersobject[]
- internal_review_timeinteger
- lead_timeinteger
- required_on_site_datestring (date)
- scheduled_taskobject
- source_submittal_log_idinteger
- distributed_submittalsobject[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- operation_item_errorsobject[]
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- ball_in_courtobject[]
- buffer_timeinteger
- prepare_timeinteger
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- idinteger
- numberstring
- revisionstring
- titlestring
/rest/v1.1/projects/{project_id}/submittals/{id}Delete Submittal
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200
No response body.
/rest/v1.1/projects/{project_id}/submittals/{id}/revisionsList a submittal's revisions
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object[]
- actual_delivery_datestring (date)
- attachmentsobject[]
- confirmed_delivery_datestring (date)
- cost_codeobject
- created_atstring (date-time)
- custom_textarea_1string
- custom_textfield_1string
- deleted_atstring (date-time)
- rich_text_descriptionstring
- design_team_review_timeinteger
- distribution_membersobject[]
- internal_review_timeinteger
- lead_timeinteger
- required_on_site_datestring (date)
- scheduled_taskobject
- source_submittal_log_idinteger
- distributed_submittalsobject[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- operation_item_errorsobject[]
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- ball_in_courtobject[]
- buffer_timeinteger
- prepare_timeinteger
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- idinteger
- numberstring
- revisionstring
- titlestring
/rest/v1.1/projects/{project_id}/submittals/{id}/revisionsCreate a new revision of a submittal
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 201 · object
- actual_delivery_datestring (date)
- attachmentsobject[]
- confirmed_delivery_datestring (date)
- cost_codeobject
- created_atstring (date-time)
- custom_textarea_1string
- custom_textfield_1string
- deleted_atstring (date-time)
- rich_text_descriptionstring
- design_team_review_timeinteger
- distribution_membersobject[]
- internal_review_timeinteger
- lead_timeinteger
- required_on_site_datestring (date)
- scheduled_taskobject
- source_submittal_log_idinteger
- distributed_submittalsobject[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- operation_item_errorsobject[]
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- ball_in_courtobject[]
- buffer_timeinteger
- prepare_timeinteger
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- idinteger
- numberstring
- revisionstring
- titlestring
/rest/v1.1/projects/{project_id}/submittals/recycle_binList of deleted Submittals
Parameters
- OS-Company-Idintegerheaderrequired
- project_idintegerpathrequired
- pageintegerquery
- per_pageintegerquery
- filters[id]integer[]query
- filters[ball_in_court_id]integerquery
- filters[created_at]string (date)query
- filters[query]stringquery
- filters[received_from_id]integerquery
- filters[responsible_contractor_id]integer[]query
- filters[specification_section_id]integer[]query
- filters[approver_id]integer[]query
- filters[current_revision]booleanquery
- filters[division]integer[]query
- filters[location_id]integer[]query
- filters[submittal_manager_id]integer[]query
- filters[submittal_package_id]integer[]query
- filters[response_id]integer[]query
- filters[status_id]integer[]query
- filters[type]string[]query
- filters[updated_at]string (date)query
- sortstringquery
Response · 200 · object[]
- approversobject[]
- attachments_countinteger
- is_rejectedboolean
- rejected_submittal_log_approver_idinteger
- required_on_site_datestring (date)
- submittal_workflow_templateobject
- submittal_workflow_template_applied_atstring (date-time)
- operation_item_errorsobject[]
- ball_in_courtobject[]
- buffer_timeinteger
- created_atstring (date-time)
- created_byobject
- current_revisionboolean
- distributed_atstring (date-time)
- closed_atstring (date-time)
- due_datestring (date)
- for_record_onlyboolean
- formatted_numberstring
- issue_datestring (date)
- privateboolean
- received_datestring (date)
- received_fromobject
- responsible_contractorobject
- specification_sectionobject
- sub_jobobject
- submit_bystring (date)
- statusobject
- typeobject
- updated_atstring (date-time)
- submittal_managerobject
- submittal_packageobject
- locationobject
- open_datestring (date)
- custom_fieldsobject
- scheduled_taskobject
- idinteger
- numberstring
- revisionstring
- titlestring