Export project documentation as PDF

Exports one page, one folder subtree, or the complete ordered project documentation tree. Folder and project exports include a title page and generated table of contents. Unchanged exports reuse the PDF cache.

POST/projects/documentation/pdf

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

projectIdstringrequired

Project UUID. This field does not accept a project short identifier. Omit rootNodeId to export the complete ordered documentation tree.

rootNodeIdstring

Page or folder node UUID. A page exports one page. A folder exports its ordered subtree.

Responses

200

Generated or cached PDF file

any

400

Invalid project or root node UUID, or an export safety limit was exceeded.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

The project or selected root node does not exist or is not accessible.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

projectIdstring*Project UUID. This field does not accept a project short identifier. Omit rootNodeId to export the complete ordered documentation tree.rootNodeIdstringPage or folder node UUID. A page exports one page. A folder exports its ordered subtree.

Request

curl -X POST "https://leadtime.app/api/public/projects/documentation/pdf" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "rootNodeId": "550e8400-e29b-41d4-a716-446655440001"
}'

const response = await fetch("https://leadtime.app/api/public/projects/documentation/pdf", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"projectId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rootNodeId\": \"550e8400-e29b-41d4-a716-446655440001\"\n}"
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/projects/documentation/pdf",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"projectId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"rootNodeId\": \"550e8400-e29b-41d4-a716-446655440001\"\n}",
)

Response

Generated or cached PDF file

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}