Get document settings

Retrieves the current document settings for the workspace.

What are Document Settings? Document settings control the appearance and formatting of all documents automatically generated by Leadtime, including letters, invoices, quotes, specifications, and project documents. These settings apply workspace-wide and can be overridden at the organization or project level.

What is returned:

Document font: The selected font family for all documents (e.g., Inter, Roboto, Arimo)
Document logo URL: Public URL to the workspace logo image (null if not set, defaults to Leadtime logo)
Project document options:
- Title page toggle (automatically adds a title page)
- Table of contents toggle (creates TOC at document start)
- Heading style (controls how headings are numbered and formatted)
Background image URLs: Public URLs for background images used on cover pages:
- Specification background (for specs documents)
- Estimate background (for proposal/quote documents)
- Custom editor background (for template-based documents)

Note: This endpoint requires the WsSettings.manageSettings permission. All file URLs are public and can be accessed without authentication.

GET/administration/document-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200

customEditorBackgroundUrlobject | nullrequired

Public URL to the background image used on custom editor document cover pages (documents created with the template system). Recommended size: 820 × 600 pixels. Formats: PNG, JPG, or SVG. The URL is publicly accessible without authentication.

documentFontstringrequired

Font family used for all documents generated by Leadtime. Available options: Inter (default), Degular, Roboto, Arimo, Open Sans, PT Sans, Oswald, EB Garamond, Permanent Marker, IBM Plex Mono.

Allowed:InterDegularRobotoArimoOpen SansPT SansOswaldEB GaramondPermanent MarkerIBM Plex Mono

documentLanguagestringrequired

Default language code for project documents (e.g., "en", "de"). Used when document language is not specified.

documentLogoUrlobject | nullrequired

Public URL to the workspace logo image. This logo appears on all generated documents. If null, the Leadtime logo is used by default. The URL is publicly accessible without authentication.

estimateBackgroundUrlobject | nullrequired

Public URL to the background image used on estimate/proposal document cover pages. Recommended size: 820 × 600 pixels. Formats: PNG, JPG, or SVG. The URL is publicly accessible without authentication.

idstringrequired

Workspace ID

offerTextsobject[]required

Array of language-specific default offer texts. Each entry contains a language code and default intro/outro texts (returned as HTML).

projectDocumentEnableTocbooleanrequired

Whether to automatically include a table of contents at the beginning of project documents (quotes, specifications, etc.). When enabled, a TOC is generated based on document headings.

projectDocumentHeadingStylestringrequired

Controls how headings are numbered and formatted in project documents. Options: `Normal` (no numbering), `Sequential` (1., 1.1., 1.1.1.), `SequentialFromSecondLevel` (top heading unnumbered), `SequentialWithParagraphs` (§ 1., § 1.1. - ideal for contracts).

Allowed:NormalSequentialSequentialFromSecondLevelSequentialWithParagraphs

projectDocumentTitlePagebooleanrequired

Whether to automatically include a title page in project documents. When enabled, a cover page is added as the first page with project and organization information.

specificationBackgroundUrlobject | nullrequired

Public URL to the background image used on specification document cover pages. Recommended size: 820 × 600 pixels. Formats: PNG, JPG, or SVG. The URL is publicly accessible without authentication.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

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

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

import requests

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

Response

{
  "customEditorBackgroundUrl": "https://app.example.com/api/files/public/123e4567-e89b-12d3-a456-426614174000",
  "documentFont": "Inter",
  "documentLanguage": "en",
  "documentLogoUrl": "https://app.example.com/api/files/public/123e4567-e89b-12d3-a456-426614174000",
  "estimateBackgroundUrl": "https://app.example.com/api/files/public/123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "offerTexts": [
    {}
  ],
  "projectDocumentEnableToc": true,
  "projectDocumentHeadingStyle": "Sequential",
  "projectDocumentTitlePage": true,
  "specificationBackgroundUrl": "https://app.example.com/api/files/public/123e4567-e89b-12d3-a456-426614174000"
}