---
title: "Batch export Sheets"
method: POST
path: "/api/v3/projects/{project_id}/sheets/batch_export"
tags: ["sheets"]
---

# Batch export Sheets

`POST /api/v3/projects/{project_id}/sheets/batch_export`

## Request

- Base URL: `https://client-api.us.fieldwire.com`
- URL: `https://client-api.us.fieldwire.com/api/v3/projects/{project_id}/sheets/batch_export`
- Auth: HTTP bearer

## Path parameters

- `project_id` string, uuid, required

## Headers

- `Fieldwire-Version` string, date, required

## Request body

- union: Schema for export request
  - object: Schema for sheet batch export input
    - `sheet_ids` string[], required: IDs of the sheet to export
    - `file_name` string, required: Name of the output pdf file
    - `options` object, required: options for the export
      - `markups` boolean, nullable: Boolean value indicating if Markups are to be exported.
      - `floorplans` boolean, nullable: Boolean value indicating if Floorplans are to be exported.
      - `attachments` boolean, nullable: Boolean value indicating if Attachments are to be exported.
      - `forms` boolean, nullable: Boolean value indicating if Forms are to be exported.
      - `photos` boolean, nullable: Boolean value indicating if Photos are to be exported.
      - `markup_colors` string[], nullable: Set of acceptable markup colors for the export
  - object
    - `jid` string, required: A unique ID to poll with until the job finishes

## Response `200`

Successful response

- union: Schema for resource export response
  - object
    - `error` string, required: The error that led to resource not getting exported
  - object
    - `url` string, required: The URL where the export can be found
  - object
    - `jid` string, required: A unique ID to poll with until the job finishes

## Other responses

- `202`: Accepted

---

[API](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api.md) - [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/revisions/34b820438c0b?raw)