Get organization details

Retrieves complete details of a specific organization, including all master data, contact information, legal details, and settings.

What is returned:

Basic information: Name, short name, icon, type, color, legal form, description
Contact details: Full address (street, city, ZIP, country, house number), phone, fax, email, website
Legal information: Tax number, registration number, registration court
Business relationship: Start of collaboration date, active status
Invoice settings: Hourly rate, payment terms, reminder fees, interest rates, invoice language
Document settings: Table of contents, title page, heading style, default contact
Logo: Public URL to the organization logo (if uploaded)
Timestamps: Creation and last update dates

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

GET/organizations/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200

addressCityobject

City

addressCountryobject

Country

addressHouseNumberobject

House number

addressStreetobject

Street address

addressZipobject

ZIP/Postal code

baseInvoiceInterestobject

Base invoice interest rate

colorstringrequired

Organization color (hex code)

createdAtstringrequired

Creation timestamp

customFieldsobject

Custom field values as key-value pairs. Keys match custom field IDs configured in workspace settings. Values match the field type (string, number, boolean, date, etc.). Use the GET /administration/organization-settings/custom-fields endpoint to retrieve available custom fields.

emailobject

Email address

enableInvoiceInterestobject

Enable invoice interest

enableInvoiceReminderFeeobject

Enable invoice reminder fee

faxNumberobject

Fax number

hourRateobject

Hourly rate

iconobject

Icon identifier

idstringrequired

Organization ID

invoiceDueDaysobject

Invoice due days

invoiceInterestobject

Invoice interest rate

invoiceLanguageobject

Invoice language code

invoiceReminderFeeobject

Invoice reminder fee amount

isActivebooleanrequired

Whether organization is active

legalFormobject

Legal form

logoUrlobject

Logo URL (publicly accessible)

namestringrequired

Organization name

parentOrganizationIdobject

Parent organization ID (for hierarchical organization structure)

parentOrganizationNameobject

Parent organization name

phoneNumberobject

Phone number

projectDocumentDefaultContactUserIdobject

Default contact user ID for project documents

projectDocumentEnableTocobject

Enable table of contents in project documents

projectDocumentHeadingStyleobject

Heading style for project documents

projectDocumentTitlePageobject

Show title page in project documents

registrationCourtobject

Registration court

registrationNumberobject

Registration number

shortDescriptionobject

Short description

shortNameobject

Short identifier

startOfCollaborationstring<date>

Start of collaboration date

tagsstring[]

Array of tag UUIDs assigned to this organization. Tags enable cross-project organization and filtering.

taxNumberobject

Tax identification number

typestringrequired

Organization type

Allowed:CustomerProspectTargetPartnerSupplierServiceProviderInvestorCompetitorGovernmentAgencyEducationalInstitution

updatedAtstringrequired

Last update timestamp

websiteobject

Website URL

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" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

import requests

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

Response

{
  "addressCity": "New York",
  "addressCountry": "USA",
  "addressHouseNumber": "42A",
  "addressStreet": "123 Main St",
  "addressZip": "10001",
  "baseInvoiceInterest": 3,
  "color": "#FF5733",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "customFields": {
    "customField1": "value1",
    "customField2": 123
  },
  "email": "contact@acme.com",
  "enableInvoiceInterest": false,
  "enableInvoiceReminderFee": true,
  "faxNumber": "+1234567891",
  "hourRate": 150,
  "icon": "building",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceDueDays": 30,
  "invoiceInterest": 5,
  "invoiceLanguage": "en",
  "invoiceReminderFee": 5,
  "isActive": true,
  "legalForm": "GmbH",
  "logoUrl": "https://app.example.com/api/files/public/123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "parentOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentOrganizationName": "B. Braun",
  "phoneNumber": "+1234567890",
  "projectDocumentDefaultContactUserId": "123e4567-e89b-12d3-a456-426614174000",
  "projectDocumentEnableToc": true,
  "projectDocumentHeadingStyle": "classic",
  "projectDocumentTitlePage": true,
  "registrationCourt": "Munich District Court",
  "registrationNumber": "HRB 12345",
  "shortDescription": "Leading software development company",
  "shortName": "ACME",
  "startOfCollaboration": "2024-01-01",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001"
  ],
  "taxNumber": "DE123456789",
  "type": "Customer",
  "updatedAt": "2024-01-15T12:30:00.000Z",
  "website": "https://acme.com"
}