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 · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredPath parameters
idstringrequiredResponses
200
addressCityobjectCity
addressCountryobjectCountry
addressHouseNumberobjectHouse number
addressStreetobjectStreet address
addressZipobjectZIP/Postal code
baseInvoiceInterestobjectBase invoice interest rate
colorstringrequiredOrganization color (hex code)
createdAtstringrequiredCreation timestamp
customFieldsobjectCustom 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.
emailobjectEmail address
enableInvoiceInterestobjectEnable invoice interest
enableInvoiceReminderFeeobjectEnable invoice reminder fee
faxNumberobjectFax number
hourRateobjectHourly rate
iconobjectIcon identifier
idstringrequiredOrganization ID
invoiceDueDaysobjectInvoice due days
invoiceInterestobjectInvoice interest rate
invoiceLanguageobjectInvoice language code
invoiceReminderFeeobjectInvoice reminder fee amount
isActivebooleanrequiredWhether organization is active
legalFormobjectLegal form
logoUrlobjectLogo URL (publicly accessible)
namestringrequiredOrganization name
parentOrganizationIdobjectParent organization ID (for hierarchical organization structure)
parentOrganizationNameobjectParent organization name
phoneNumberobjectPhone number
projectDocumentDefaultContactUserIdobjectDefault contact user ID for project documents
projectDocumentEnableTocobjectEnable table of contents in project documents
projectDocumentHeadingStyleobjectHeading style for project documents
projectDocumentTitlePageobjectShow title page in project documents
registrationCourtobjectRegistration court
registrationNumberobjectRegistration number
shortDescriptionobjectShort description
shortNameobjectShort identifier
startOfCollaborationstring<date>Start of collaboration date
tagsstring[]Array of tag UUIDs assigned to this organization. Tags enable cross-project organization and filtering.
taxNumberobjectTax identification number
typestringrequiredOrganization type
Allowed:
CustomerProspectTargetPartnerSupplierServiceProviderInvestorCompetitorGovernmentAgencyEducationalInstitutionupdatedAtstringrequiredLast update timestamp
websiteobjectWebsite URL
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
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"
}Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions