---
updatedAt: 2026-06-03T14:46:37.000Z
agentTools:
  projectIndex: https://developers.fieldwire.com/llms.txt
---

# Batch export Floorplans

# 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": {
      "floorplan_batch_export_input": {
        "type": "object",
        "required": [
          "layers"
        ],
        "nullable": false,
        "description": "Schema for batch export floorplan input. Eligible Floorplans are the ones in your Project.",
        "properties": {
          "floorplan_ids": {
            "type": "array",
            "nullable": true,
            "description": "List of Floorplan IDs to further filter the export list by",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "folder_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "Only export Floorplans in this Folder ID."
          },
          "layers": {
            "type": "object",
            "nullable": false,
            "description": "The layers of the Floorplan to batch export.",
            "properties": {
              "markups": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if Markups are to be exported."
              },
              "floorplans": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if Floorplans are to be exported."
              },
              "attachments": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if Attachments are to be exported."
              },
              "forms": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if Forms are to be exported."
              },
              "photos": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if Photos are to be exported."
              },
              "markup_colors": {
                "type": "array",
                "description": "Set of acceptable markup colors for the Floorplan layers",
                "nullable": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "RED",
                    "DARK_BLUE",
                    "ORANGE",
                    "DARK_GREEN",
                    "PINK",
                    "LIGHT_BLUE",
                    "YELLOW",
                    "LIGHT_GREEN",
                    "WHITE",
                    "BLACK",
                    "PRIVATE"
                  ],
                  "description": "Enum of Acceptable Floorplan markup colors"
                }
              },
              "tasks": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if tasks are to be exported."
              },
              "spec_sections": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if spec sections are to be exported."
              },
              "rfis": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if rfis are to be exported."
              },
              "submittals": {
                "type": "boolean",
                "nullable": true,
                "description": "Boolean value indicating if submittals are to be exported."
              }
            },
            "additionalProperties": false
          },
          "export_type": {
            "type": "string",
            "nullable": true,
            "description": "Control the type of output that will be generated on export. Defaults to zip.",
            "enum": [
              "zip",
              "pdf"
            ]
          },
          "sheet_ids": {
            "type": "array",
            "nullable": true,
            "description": "List of Sheet IDs to export specific plan versions instead of the current version for each Floorplan. The Floorplan owning each Sheet ID must be part of the exported set (via floorplan_ids, folder_id, or the default export-all when neither is given), or the override has no effect for that Sheet ID.",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          }
        },
        "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}/floorplans/batch_export": {
      "post": {
        "summary": "Batch export Floorplans",
        "operationId": "batch_export_floorplans",
        "tags": [
          "floorplans"
        ],
        "security": [
          {
            "jwt": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/project_id"
          },
          {
            "$ref": "#/components/parameters/api_version"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "headers": {
              "X-Current-User-Id": {
                "$ref": "#/components/headers/current_user_id"
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/floorplan_batch_export_input"
              }
            }
          },
          "required": true
        }
      }
    }
  }
}
```