---
title: "Generates a project PDF"
method: POST
path: "/projects/{projectId}/pdf"
tags: ["Projects"]
---

# Generates a project PDF

`POST /projects/{projectId}/pdf`

## Path parameters

- `projectId` integer, required

## Request body

- GeneratePdfRequest
  - `file_type` 'pdf' | 'zip', required — File type
  - `export_type` 'archive' | 'customer', required — Export type
  - `assignments` integer[] — Appointment Ids
  - `settings` object — PDF settings
    - `show_frontpage` boolean — Show frontpage
    - `show_place_of_billing` boolean — Show place of billing
    - `show_footer` boolean — Show footer
    - `show_tools` boolean — Show tools
    - `show_instructions` boolean — Show instructions
    - `show_tags` boolean — Show labels
    - `show_states` boolean — Show status
    - `show_place_of_fullfillment` boolean — Show place of fullfillment
    - `show_employees` boolean — Show assigned employees
    - `show_vehicles` boolean — Show vehicles
    - `show_document_photos` 'NO' | 'THUMB' | 'LARGE' — Show appointment photos
    - `show_notes` boolean — Show notes
    - `show_project_description` boolean — Show project description
    - `show_materials` boolean — Show used materials
    - `show_time` boolean — Show project time
    - `show_documentation_photos` 'NO' | 'THUMB' | 'LARGE' — Show protocol entry photos
    - `attach_documents` boolean — Attach documents (creates a ZIP file)
    - `attach_documentations` boolean — Attach edited PDFs and uploaded files (creates a ZIP file)
  - `locale` 'de_DE' | 'en_US' | 'pl_PL' | 'uk_UA' | 'ro_RO' | 'es_ES' — Language

## Response `200`

The request was successful.

## Other responses

- `401` — The request lacks valid authentication credentials.
- `403` — The token is valid but lacks the permission for this action.
- `404` — The requested resource could not be found.
- `422` — The request was well-formed but contains semantic errors (validation failed).
- `500` — An unexpected error occurred on the server (e.g. a requested relation does not exist).

---

[API](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation.md) · [All operations](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/craftboxx/craftboxx-api-documentation/versions/c01f07a02f77/schema)