Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

List project journal entries

Retrieves a paginated grid of project journal entries with filtering and sorting capabilities. Filterable fields: id, projectId, createdAt, createdBy, mood, reminder. Sortable fields: id, projectId, createdAt, createdBy, mood, reminder.

What are Project Journals? Project journals are chronological records of important project events, observations, feedback, risks, and internal notes. They act as a timeline-based memory for projects, helping stakeholders track developments, assess communication, and prevent knowledge loss.

What is returned:

  • Journal entry identification (ID, projectId)
  • Content (body as HTML, mood indicator)
  • Metadata (createdAt, createdBy, lastUpdated)
  • Optional reminder date for follow-ups

Journal Entry Features:

  • Mood indicators: Sad (negative reactions, problems), Neutral (factual observations), Happy (positive feedback, wins)
  • Rich text content: Supports formatted text with paragraphs, highlighting, and structuring
  • Reminder function: Optional date-based reminders for follow-ups or review points

Filtering and search:

  • Filter by projectId to view entries for a specific project
  • Filter by mood, creation date, creator, or reminder date
  • Sort by any sortable field (default: createdAt descending)
  • Server-side pagination for large journal lists

Permissions: Automatically filters journal entries based on user permissions. Users without Projects.seeAnyProject permission will only see journal entries for projects they have access to.

GET/projects/journal
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
filtersstring
JSON string containing filter configuration. **Available Fields:** - **id** (string): Journal entry ID - **projectId** (string): Project ID - **createdAt** (date): Journal entry creation timestamp - **createdBy** (string): Creator user ID - **mood** (set): Journal entry mood - **reminder** (date): Reminder date **Filter Structure:** ```json [ { "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):** ```json [ { "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): Journal entry ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **projectId** (string): Project ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **createdAt** (date): Journal entry creation timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty - **createdBy** (string): Creator user ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **mood** (set): Journal entry mood (set filter). Available comparisons: in, not_in, is_empty, is_not_empty - **reminder** (date): Reminder date (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, 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**: Journal entry ID - **projectId**: Project ID - **createdAt**: Journal entry creation timestamp - **createdBy**: Creator user ID - **mood**: Journal entry mood - **reminder**: Reminder date **Sort Structure:** ```json [ { "field": "field_name", "direction": "asc|desc" } ] ``` **Default Sort:** createdAt (desc)
fieldsToReturnany[]
Comma-separated list of field names to include in response items. If not provided, all fields are returned. **Available Fields:** id, projectId, createdAt, createdBy, mood, reminder, body
Responses
200Paginated list of project journal entries
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/projects/journal" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Paginated list of project journal entries