Skip to content
Leadtime
English
EnglishDeutschNot translated
Esc
↑↓navigate↵open⌘Jpreview

List organization letters

What are Organization Letters? Organization letters are formal business correspondence documents that can be created, managed, and stored directly in Leadtime. They provide centralized, traceable communication linked to each organization, reducing media discontinuity and making it easier to document business correspondence.

What this endpoint does: Returns a paginated, sortable, and filterable list of all organization letters in the workspace. You can view letters for a specific organization or all letters across the workspace.

What data is returned:

  • Letter metadata: ID, subject, date, organization, member (if applicable)
  • Timestamps: creation date, last update date
  • Creator information: who created the letter
  • Address type: whether the letter is addressed to the organization or a specific member

Supported operations: Retrieves a paginated grid of organization letters with filtering and sorting capabilities. Quick search available on: subject. Filterable fields: id, organizationId, organizationName, memberId, subject, dateOfLetter, addressType, createdAt, lastUpdated, createdBy. Sortable fields: id, organizationId, organizationName, memberId, subject, dateOfLetter, addressType, createdAt, lastUpdated, createdBy.

Use cases:

  • View all letters for a specific organization
  • Search and filter letters by subject, date, or member
  • Track letter creation and modification history
  • Export letter lists for reporting

Note: Requires seeLetters permission on the Organizations resource.

GET/organizations/letters
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
pagenumber

Page number (1-based)

pageSizenumber

Number of items per page

viewIdstring

View identifier for saved grid configurations

quickSearchstring

Quick search text. Searches across: subject

filtersstring

JSON string containing filter configuration.

Available Fields:

  • id (string): Letter ID
  • organizationId (set): Organization ID
  • organizationName (string): Organization name
  • memberId (set): Organization member ID (null if not member-specific)
  • subject (string): Letter subject
  • dateOfLetter (date): Date of the letter
  • addressType (set): Address type (Organization or Member)
  • createdAt (date): Creation timestamp
  • lastUpdated (date): Last update timestamp
  • createdBy (set): ID of user who created the letter

Filter Structure:

[
  {
    "type": "string|number|date|set|boolean|array|task_status|task_type",
    "fieldName": "field_name",
    "value": {
      "comparison": "comparison_type",
      "value": "filter_value"
    }
  }
]

Group Filters (AND/OR Combinations):

[
  {
    "type": "group",
    "fieldName": "group0.18807479823070028",
    "value": {
      "type": "or",
      "filters": [
        {
          "type": "string",
          "fieldName": "fileName",
          "value": {
            "comparison": "contain",
            "value": "aa"
          }
        },
        {
          "type": "number",
          "fieldName": "rowCount",
          "value": {
            "comparison": ">=",
            "value": 33
          }
        }
      ]
    }
  }
]

Available Comparison Operators:

  • id (string): Letter ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
  • organizationId (set): Organization ID (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
  • organizationName (string): Organization name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
  • memberId (set): Organization member ID (null if not member-specific) (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
  • subject (string): Letter subject (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
  • dateOfLetter (date): Date of the letter (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
  • addressType (set): Address type (Organization or Member) (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
  • createdAt (date): Creation timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
  • lastUpdated (date): Last update timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
  • createdBy (set): ID of user who created the letter (set filter). Available comparisons: in, not_in, is_empty, is_not_empty

Note: Use quickSearch parameter for simple text search instead of adding it to filters.

sortstring

JSON array of sort objects.

Sortable Fields:

  • id: Letter ID
  • organizationId: Organization ID
  • organizationName: Organization name
  • memberId: Organization member ID (null if not member-specific)
  • subject: Letter subject
  • dateOfLetter: Date of the letter
  • addressType: Address type (Organization or Member)
  • createdAt: Creation timestamp
  • lastUpdated: Last update timestamp
  • createdBy: ID of user who created the letter

Sort Structure:

[
  {
    "field": "field_name",
    "direction": "asc|desc"
  }
]

Default Sort: lastUpdated (desc)

fieldsToReturnstring[]

Comma-separated list of field names to include in response items. If not provided, all fields are returned.

Available Fields: id, organizationId, organizationName, memberId, subject, dateOfLetter, addressType, createdAt, lastUpdated, createdBy

Responses
200

Paginated list of organization letters

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it
Server
Authorization
Parameters
Request
curl -X GET "https://leadtime.app/api/public/organizations/letters" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Paginated list of organization letters