--- updatedAt: 2026-06-03T14:46:37.000Z agentTools: projectIndex: https://developers.fieldwire.com/llms.txt --- # Import new submittals # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Fieldwire Regional API", "version": "v3" }, "servers": [ { "url": "https://client-api.{region}.fieldwire.com", "variables": { "region": { "default": "us", "enum": [ "ca", "eu", "us" ] } } } ], "components": { "headers": { "current_user_id": { "description": "Current user's id", "schema": { "type": "integer" } } }, "parameters": { "api_version": { "name": "Fieldwire-Version", "in": "header", "description": "Specifies the version of the API to talk to", "required": true, "schema": { "type": "string", "format": "date" } }, "project_id": { "name": "project_id", "in": "path", "description": "ID of the project this entity belongs to", "required": true, "schema": { "type": "string", "format": "uuid" } } }, "schemas": { "validation_errors": { "type": "object", "nullable": false, "required": [ "errors" ], "description": "Error response using the extended validation error format", "properties": { "errors": { "type": "array", "nullable": false, "description": "The list of errors stopping an action from going through", "items": { "type": "object", "nullable": false, "required": [ "type", "code", "message", "details" ], "properties": { "type": { "type": "string", "nullable": false, "description": "Error type", "example": "validation_error" }, "code": { "type": "string", "nullable": false, "description": "Error code", "example": "missing_or_empty" }, "message": { "type": "string", "nullable": false, "description": "Human-readable error message" }, "details": { "type": "object", "nullable": false, "description": "Additional context about the error (ex: the offending param)" } }, "additionalProperties": false } } }, "additionalProperties": false }, "submittal_import_input": { "type": "object", "description": "Input needed for batch import of single submittal.", "required": [ "name" ], "nullable": false, "properties": { "name": { "type": "string", "nullable": false, "description": "Submittal name." }, "description": { "type": "string", "nullable": true, "description": "Submittal description." }, "specification": { "type": "string", "nullable": true, "description": "Submittal spec number." }, "type": { "type": "string", "nullable": true, "description": "Submittal type." } }, "additionalProperties": false }, "submittal_batch_import_input_schema": { "type": "object", "description": "Input needed for batch import of Submittals.", "required": [ "submittals_data" ], "nullable": false, "properties": { "submittals_data": { "type": "array", "nullable": false, "description": "List of user ids associated with the watchers to be created/added.", "items": { "$ref": "#/components/schemas/submittal_import_input" } } }, "additionalProperties": false } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Access token (JWT) generated using the acquired refresh token (API token). Our [authentication](https://developers.fieldwire.com/docs/authentication) guide covers the steps to generate a valid token" } } }, "paths": { "/api/v3/projects/{project_id}/submittals/batch_import": { "post": { "summary": "Import new submittals", "operationId": "import_submittals_into_project", "tags": [ "submittals" ], "security": [ { "jwt": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id" }, { "$ref": "#/components/parameters/api_version" } ], "responses": { "201": { "description": "Successful response", "headers": { "X-Current-User-Id": { "$ref": "#/components/headers/current_user_id" } }, "content": { "application/json": { "example": [ { "id": "e283944a-63cf-4ecb-aee9-fb8a2a247100", "creator_user_id": 2385, "last_editor_user_id": 2385, "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "resolved_conflict": false, "created_at": "2026-10-02T14:53:28.451Z", "updated_at": "2026-10-02T14:53:28.454Z", "device_created_at": "2026-10-02T14:53:28.451Z", "device_updated_at": "2026-10-02T14:53:28.451Z", "deleted_at": null, "current_submittal_revision_id": "4ec4c790-12a2-4fa9-a65e-6323734554b8", "submitting_user_id": null, "approving_user_id": null, "requesting_user_id": null, "closing_user_id": null, "submittal_type_id": "cc147585-b9a9-4e6b-83ff-bb4a0a0034a5", "name": "test 1", "description": "description", "reference_number": null, "submittal_code": "-", "status": "draft", "revision_number": 0, "submit_by_date": null, "requested_at": null, "assigned_at": null, "review_by_date": null, "reviewed_at": null, "approve_by_date": null, "approved_at": null, "closed_at": null, "voided_at": null, "creator_pm_group_id": "bc93369d-1aac-4729-9dfc-a6f7b36ed553", "submitting_pm_group_id": null, "is_reminder_enabled": true, "lead_time": null, "on_site_date": null, "suggested_submit_by_date": null, "workflow": "default", "submission_received_at": null, "response_received_at": null, "submitted_at": null, "responded_at": null, "sent_for_approval_at": null, "response_time": null, "response": null, "reviewers": null, "consolidated_current_number": "", "submittal_type_name": "Fire Sprinkler System", "code": null, "number": null, "spec_section": { "id": "5cf6be47-dfec-4ca0-9a55-3174d4dc7de3", "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "section_number": "44580", "conflict": false, "processing": false, "error": false, "current_version_title": "this is a spec section (version)", "current_version_description": "1/2/2099", "deleted_at": null, "current_version_id": "abd7c749-2fd5-4e9d-8f56-9b1b0304b0de", "creator_user_id": 2385, "last_editor_user_id": 2385, "created_at": "2026-10-02T14:53:28.062Z", "updated_at": "2026-10-02T14:53:28.117Z", "device_created_at": "2026-10-02T14:53:28.062Z", "device_updated_at": "2026-10-02T14:53:28.062Z", "current_version_thumb_url": null, "current_version_file_url": "http://example.com/90df58cc-4d8f-42d6-ba59-88c97360fde3-name" }, "spec_section_id": "5cf6be47-dfec-4ca0-9a55-3174d4dc7de3", "spec_section_project_resource_link": { "id": "eed08832-1d9d-4414-ac76-a2e462e1f161", "creator_user_id": 2385, "last_editor_user_id": 2385, "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "resolved_conflict": false, "created_at": "2026-10-02T14:53:28.454Z", "updated_at": "2026-10-02T14:53:28.454Z", "device_created_at": "2026-10-02T14:53:28.454Z", "device_updated_at": "2026-10-02T14:53:28.454Z", "deleted_at": null, "entity_id_1": "5cf6be47-dfec-4ca0-9a55-3174d4dc7de3", "entity_id_2": "e283944a-63cf-4ecb-aee9-fb8a2a247100", "entity_type_1": "SpecSection", "entity_type_2": "Submittal", "data": null }, "submittal_type": { "id": "cc147585-b9a9-4e6b-83ff-bb4a0a0034a5", "name": "Fire Sprinkler System", "aliases": null, "translation_key": null, "created_at": "2026-10-01T00:00:00.000Z", "updated_at": "2026-10-01T00:00:00.000Z", "deleted_at": null, "deactivated_at": null }, "submittal_assignee": { "user_id": 2385, "id": "b74dea31-5ac3-4071-9262-e38015b622ac", "email": null, "language": "en", "kind": "user", "user": { "user_id": 2385, "full_name": "John Doe", "pm_group_id": "bc93369d-1aac-4729-9dfc-a6f7b36ed553", "pm_group_name": "Uncategorized", "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "role": "admin", "pm_role": "manager" } }, "assignee_user_id": 2385, "assignees": [ { "user_id": 2385, "id": "b74dea31-5ac3-4071-9262-e38015b622ac", "email": null, "language": "en", "kind": "user", "user": { "user_id": 2385, "full_name": "John Doe", "pm_group_id": "bc93369d-1aac-4729-9dfc-a6f7b36ed553", "pm_group_name": "Uncategorized", "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "role": "admin", "pm_role": "manager" } } ] }, { "id": "47863b0a-d096-4528-9ce9-b9abc81fd4d6", "creator_user_id": 2385, "last_editor_user_id": 2385, "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "resolved_conflict": false, "created_at": "2026-10-02T14:53:28.451Z", "updated_at": "2026-10-02T14:53:28.454Z", "device_created_at": "2026-10-02T14:53:28.451Z", "device_updated_at": "2026-10-02T14:53:28.451Z", "deleted_at": null, "current_submittal_revision_id": "a30451f1-3256-4191-ba45-6aee35f798f5", "submitting_user_id": null, "approving_user_id": null, "requesting_user_id": null, "closing_user_id": null, "submittal_type_id": "deb9a8b3-93a2-49b0-b9cf-5848a6152765", "name": "test 2", "description": null, "reference_number": null, "submittal_code": "-", "status": "draft", "revision_number": 0, "submit_by_date": null, "requested_at": null, "assigned_at": null, "review_by_date": null, "reviewed_at": null, "approve_by_date": null, "approved_at": null, "closed_at": null, "voided_at": null, "creator_pm_group_id": "bc93369d-1aac-4729-9dfc-a6f7b36ed553", "submitting_pm_group_id": null, "is_reminder_enabled": true, "lead_time": null, "on_site_date": null, "suggested_submit_by_date": null, "workflow": "default", "submission_received_at": null, "response_received_at": null, "submitted_at": null, "responded_at": null, "sent_for_approval_at": null, "response_time": null, "response": null, "reviewers": null, "consolidated_current_number": "", "submittal_type_name": "Other", "code": null, "number": null, "spec_section": null, "spec_section_id": null, "spec_section_project_resource_link": null, "submittal_type": { "id": "deb9a8b3-93a2-49b0-b9cf-5848a6152765", "name": "Other", "aliases": null, "translation_key": "OTHER", "created_at": "2026-10-02T14:47:12.253Z", "updated_at": "2026-10-02T14:47:12.253Z", "deleted_at": null, "deactivated_at": null }, "submittal_assignee": { "user_id": 2385, "id": "f6bd83d8-8439-4cef-9e30-64c92f003121", "email": null, "language": "en", "kind": "user", "user": { "user_id": 2385, "full_name": "John Doe", "pm_group_id": "bc93369d-1aac-4729-9dfc-a6f7b36ed553", "pm_group_name": "Uncategorized", "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "role": "admin", "pm_role": "manager" } }, "assignee_user_id": 2385, "assignees": [ { "user_id": 2385, "id": "f6bd83d8-8439-4cef-9e30-64c92f003121", "email": null, "language": "en", "kind": "user", "user": { "user_id": 2385, "full_name": "John Doe", "pm_group_id": "bc93369d-1aac-4729-9dfc-a6f7b36ed553", "pm_group_name": "Uncategorized", "project_id": "64945c77-c047-4eea-853c-fd3c1bda09b5", "role": "admin", "pm_role": "manager" } } ] } ] } } }, "422": { "description": "Unsuccessful response: Submittal name is required", "headers": { "X-Current-User-Id": { "$ref": "#/components/headers/current_user_id" } }, "content": { "application/json": { "example": { "errors": [ { "type": "validation_error", "code": "missing_or_empty", "message": "submittals_data[0].name is missing or empty", "details": { "param": "name" } } ] }, "schema": { "$ref": "#/components/schemas/validation_errors" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/submittal_batch_import_input_schema" } } }, "required": true } } } } } ```