Get project document settings

Returns document settings for a specific project including current values and inherited defaults from organization/workspace hierarchy.

What are Project Document Settings? Project document settings control formatting options and contact information for automatically generated documents such as proposals, contracts, requirement specifications, and other project documents. These settings can override organization/workspace defaults on a per-project basis, allowing you to customize document appearance and structure for specific projects.

Settings Overview:

Title Page: Controls whether generated documents include a title page
Table of Contents: Determines if an automatically generated table of contents is embedded (especially helpful for long documents)
Heading Style: Controls the numbering and formatting of headings (Normal, Sequential, SequentialFromSecondLevel, SequentialWithParagraphs)
Default Contact Person: Sets the contact person automatically when creating new documents (useful for recurring offer processes and automated preambles)

Inheritance System: Settings support a three-level inheritance hierarchy:

Project-level settings: Project-specific overrides (null = inherit from organization)
Organization-level defaults: Organization-specific defaults (null = inherit from workspace)
Workspace-level defaults: Global workspace defaults

The response includes both current project values and the inherited defaults from the organization/workspace hierarchy. Null values in current settings indicate that the project inherits from organization/workspace defaults. The “*Default” fields show what values are inherited when project settings are null.

GET/projects/{id}/document-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200

idstringrequired

Project UUID

projectDocumentDefaultContactUserIdobject | nullrequired

Default contact person user ID for project documents. This person is automatically set as the contact when creating new documents for this project. Useful for recurring offer processes, automated preambles, and binding customer-side addressing. When null, the project inherits the organization default (if set) or no default contact is used. Must be a valid user UUID from the workspace.

projectDocumentDefaultContactUserIdDefaultobject | nullrequired

Default contact person user ID inherited from organization hierarchy. This is the value that will be used when projectDocumentDefaultContactUserId is null. When null, there is no default contact person set at the organization/workspace level.

projectDocumentEnableTocobject | nullrequired

Enable table of contents for project documents. When true, automatically generated documents include a table of contents. When false, table of contents is disabled for this project. When null, the project inherits the organization/workspace default. This setting is especially helpful for long documents and makes them easier to navigate.

projectDocumentEnableTocDefaultbooleanrequired

Default value for table of contents inherited from organization/workspace hierarchy. This is the value that will be used when projectDocumentEnableToc is null. Shows what the organization or workspace default is set to.

projectDocumentHeadingStylestring | nullrequired

Heading style for project documents. Controls the numbering and formatting of headings in generated documents. This feature keeps document outlines consistent, especially in contract documents when dynamic sections appear or disappear based on form parameters. When null, the project inherits the organization/workspace default. Available styles: Normal (no numbering), Sequential (numbering from level 1), SequentialFromSecondLevel (numbering from level 2), SequentialWithParagraphs (numbering with symbol prefix like §).

Allowed:NormalSequentialSequentialFromSecondLevelSequentialWithParagraphs

projectDocumentHeadingStyleDefaultstringrequired

Default heading style inherited from organization/workspace hierarchy. This is the value that will be used when projectDocumentHeadingStyle is null. Shows what the organization or workspace default heading style is set to.

Allowed:NormalSequentialSequentialFromSecondLevelSequentialWithParagraphs

projectDocumentTitlePageobject | nullrequired

Enable title page for project documents. When true, generated documents include a title page. When false, title page is disabled for this project. When null, the project inherits the organization/workspace default.

projectDocumentTitlePageDefaultbooleanrequired

Default value for title page inherited from organization/workspace hierarchy. This is the value that will be used when projectDocumentTitlePage is null. Shows what the organization or workspace default is set to.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

curl -X GET "https://leadtime.app/api/public/projects/string/document-settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/string/document-settings", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/string/document-settings",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "projectDocumentDefaultContactUserId": "550e8400-e29b-41d4-a716-446655440001",
  "projectDocumentDefaultContactUserIdDefault": "550e8400-e29b-41d4-a716-446655440002",
  "projectDocumentEnableToc": true,
  "projectDocumentEnableTocDefault": false,
  "projectDocumentHeadingStyle": "Sequential",
  "projectDocumentHeadingStyleDefault": "Normal",
  "projectDocumentTitlePage": true,
  "projectDocumentTitlePageDefault": true
}