Get organization letter details

What this endpoint does: Retrieves complete details of a specific organization letter, including the full letter body content converted to HTML format.

What is returned:

Letter metadata: ID, subject, date, organization ID, member ID (if applicable)
Address type: Organization or Member
Body content: Full letter text in HTML format (converted from internal IDoc format)
Timestamps: Creation date and last update date
Creator: User ID of who created the letter

Use cases:

Display letter content in a viewer or editor
Generate PDF exports of letters
Retrieve letter details for editing
Audit letter history and metadata

Note: Requires seeLetters permission on the Organizations resource.

GET/organizations/letters/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200

addressTypeobjectrequired

The address type used for this letter. "Organization" means the organization's main address was used, "Member" means a member's private address was used.

Show properties

object

bodystringrequired

The letter body content in HTML format. This has been converted from the internal IDoc storage format to HTML for easy display and processing. Includes all formatting, template variables (as HTML spans), and rich text elements.

createdAtstring<date-time>required

ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when the letter was first created in the system.

createdBystringrequired

UUID of the user who created this letter. Use this to track authorship and for audit purposes.

dateOfLetterstring<date-time>required

The date shown on the letter in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). This is the date that appears on the letter document itself, which may differ from the creation date.

idstringrequired

Unique identifier (UUID) of the organization letter

lastUpdatedstring<date-time>required

ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when the letter was last modified. This is automatically updated whenever any field of the letter is changed.

memberIdobject | nullrequired

UUID of the organization member (contact person) this letter is addressed to. Will be null if the letter is addressed to the organization itself rather than a specific member.

organizationIdstringrequired

UUID of the organization this letter belongs to. Use this to link the letter to the correct organization.

subjectstringrequired

The subject or title of the letter as displayed in listings and on the document.

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

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

import requests

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

Response

{
  "addressType": "Organization",
  "body": "<h1>Dear Customer</h1><p>This is a reminder...</p>",
  "createdAt": "2024-01-10T10:30:00.000Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174003",
  "dateOfLetter": "2024-01-15T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastUpdated": "2024-01-12T14:20:00.000Z",
  "memberId": "123e4567-e89b-12d3-a456-426614174002",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "subject": "Invoice Reminder"
}