Get organization document settings

Retrieves document formatting settings for a specific organization. These settings control how project documents (quotes, requirement documents, contracts) are formatted for this organization.

What are Document Settings? Document settings allow you to customize the appearance and structure of automatically generated project documents on a per-organization basis. These settings override the workspace defaults, enabling customer-specific document layouts and formatting.

What is returned:

Organization-specific settings: Values set for this organization (can be null to inherit from workspace)
- projectDocumentEnableToc: Whether to include a table of contents
- projectDocumentTitlePage: Whether to show a title/cover page
- projectDocumentHeadingStyle: Formatting style for headings (e.g., Sequential, Normal)
- projectDocumentDefaultContactUserId: Default contact person for documents
Workspace defaults: The default values that apply when organization settings are null
- projectDocumentEnableTocDefault: Workspace default for table of contents
- projectDocumentTitlePageDefault: Workspace default for title page
- projectDocumentHeadingStyleDefault: Workspace default heading style

Inheritance behavior:

If an organization setting is null, the workspace default is used
If an organization setting has a value, it overrides the workspace default
This allows you to customize documents per customer while maintaining workspace-wide defaults

Use cases:

Different document layouts for specific customers
Custom corporate design requirements
Creating documents for external partners without internal formatting

Note: This endpoint requires the Organizations.view permission. The organization must exist in your workspace and not be deleted.

GET/organizations/{id}/document-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200

documentLanguageobject | nullrequired

Document language override for this organization. Overrides workspace default. Null if not set (inherits workspace default).

documentLanguageDefaultstringrequired

Workspace default document language. This value is used when the organization-specific setting is null.

idstringrequired

Organization ID

offerTextsobject | nullrequired

Offer text overrides for this organization (returned as HTML). Overrides workspace defaults. Null if not set (inherits workspace defaults).

offerTextsWorkspaceDefaultobjectrequired

Workspace default offer texts (returned as HTML). These are used when organization-specific texts are not set.

Show properties

offerIntroTextobject | null

Custom intro text for offers (HTML or Markdown). Overrides workspace default. Set to null to clear.

offerOutroTextobject | null

Custom outro text for offers (HTML or Markdown). Overrides workspace default. Set to null to clear.

projectDocumentDefaultContactUserIdobject | nullrequired

UUID of the organization member (contact person) who will be automatically set as the recipient for new project documents created for this organization. Set to null to clear the default contact.

projectDocumentEnableTocobject | nullrequired

Whether to automatically include a table of contents in project documents for this organization. Set to null to inherit the workspace default, true to enable, or false to disable.

projectDocumentEnableTocDefaultbooleanrequired

Workspace default setting for enabling table of contents in project documents. This value is used when the organization-specific setting is null.

projectDocumentHeadingStylestring | nullrequired

Formatting style for headings in project documents (e.g., Sequential, Normal). Controls the hierarchy and appearance of document headings. Set to null to inherit the workspace default, or provide a specific style to override.

Allowed:NormalSequentialSequentialFromSecondLevelSequentialWithParagraphs

projectDocumentHeadingStyleDefaultstringrequired

Workspace default heading style for project documents. This value is used when the organization-specific setting is null.

Allowed:NormalSequentialSequentialFromSecondLevelSequentialWithParagraphs

projectDocumentTitlePageobject | nullrequired

Whether to include a title/cover page in project documents for this organization. Set to null to inherit the workspace default, true to enable, or false to disable.

projectDocumentTitlePageDefaultbooleanrequired

Workspace default setting for showing title/cover page in project documents. This value is used when the organization-specific setting is null.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*

Request

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

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

import requests

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

Response

{
  "documentLanguage": "de",
  "documentLanguageDefault": "en",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "offerTexts": {},
  "offerTextsWorkspaceDefault": {
    "offerIntroText": {},
    "offerOutroText": {}
  },
  "projectDocumentDefaultContactUserId": "123e4567-e89b-12d3-a456-426614174000",
  "projectDocumentEnableToc": true,
  "projectDocumentEnableTocDefault": true,
  "projectDocumentHeadingStyle": "Sequential",
  "projectDocumentHeadingStyleDefault": "Normal",
  "projectDocumentTitlePage": false,
  "projectDocumentTitlePageDefault": true
}