Get company settings

Retrieves the company master data including legal entity information, contact details, and address.

What is Company Data? Company data contains all the legal, administrative, and contact details of your company. This information is used automatically throughout the system in invoices, contracts, projects, and other documents.

What is returned:

Company identification: Official company name and legal form (e.g., GmbH, AG, LLC)
Complete address: Country, postal code, city, street, house number
Contact information: Phone number, email address, website URL, fax number
Tax and registry details: Tax identification number, business registration number, registration court
Company description: Short description of what the company does
Financial information: Bank account number (IBAN) used for invoices

Note: This endpoint requires the Company.view permission. Company data serves as the foundation for correct legal information, consistent communication, and automated document generation throughout Leadtime.

GET/administration/company-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200

companyCitystring

City of the company address. Part of the complete address used on invoices, contracts, and other documents.

companyCountrystring

Country code (ISO 3166-1 alpha-2 format, e.g., "DE", "US") of the company address. Part of the complete address used on invoices, contracts, and other documents.

companyEmailstring

Main business contact email address. Used for contact information in documents and communications.

companyFaxstring

Company fax number (optional). Used for contact information in documents and communications. For companies that still use fax.

companyHouseNumberstring

House number of the company address. Part of the complete address used on invoices, contracts, and other documents.

companyLegalFormstring

Legal form or structure of the company (e.g., GmbH, AG, LLC, Inc., sole proprietorship). Used in legal documents and official communications.

companyNamestringrequired

Official business name of the company. Used in documents, invoices, contracts, and projects throughout the system.

companyPhonestring

Official company phone number. Used for contact information in documents and communications.

companyRegistrationCourtstring

Responsible registration court where the company is registered. Example: "Amtsgericht Berlin" for German companies.

companyRegistrationNumberstring

Business registration number or commercial registry entry number. Format varies by country (e.g., "HRB 12345" for German companies).

companyShortDescriptionstring

Short description of what the company does. Optional field to describe the company's business activities. Example: "Manufacturer of Leadtime – an ERP system for software providers."

companyStreetstring

Street name of the company address. Part of the complete address used on invoices, contracts, and other documents.

companyTaxNumberstring

Tax identification number. Required for invoices and tax documents. Format varies by country (e.g., "DE123456789" for Germany).

companyWebsitestring

Company website URL (optional). Used for contact information in documents and communications.

companyZipstring

ZIP or postal code of the company address. Part of the complete address used on invoices, contracts, and other documents.

invoiceAccountNumberstring

Bank account number in IBAN format used for invoices. This account number appears on invoices for payment purposes.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

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

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

import requests

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

Response

{
  "companyCity": "Berlin",
  "companyCountry": "DE",
  "companyEmail": "contact@acme.com",
  "companyFax": "+49 30 87654321",
  "companyHouseNumber": "42",
  "companyLegalForm": "GmbH",
  "companyName": "Acme Corporation",
  "companyPhone": "+49 30 12345678",
  "companyRegistrationCourt": "Amtsgericht Berlin",
  "companyRegistrationNumber": "HRB 12345",
  "companyShortDescription": "string",
  "companyStreet": "123 Main St",
  "companyTaxNumber": "DE123456789",
  "companyWebsite": "https://acme.com",
  "companyZip": "10115",
  "invoiceAccountNumber": "DE89370400440532013000"
}