List employee journal entries

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

What are Employee Journals? Employee journals are used to document notes, observations, conversations, and feedback about employees. They help track interactions, performance notes, and important information about team members.

What is returned:

Journal entry ID and associated employee ID
Rich text content (body) converted to HTML format
Mood indicator (Happy, Neutral, or Sad)
Optional reminder date for follow-ups
Creation and update timestamps
Creator user ID

Permission-based filtering:

Users with Employees.manage permission: See all journal entries for all employees
Users without Employees.manage permission: Only see entries for their own employee record where visibleToSubject = true
Employees can create their own entries, which are automatically marked as visible to themselves

Filtering options:

Filter by employeeId to view entries for a specific employee
Filter by mood to find entries with specific emotional indicators
Filter by createdAt or lastUpdated to find entries within date ranges
Filter by reminder to find entries with upcoming or past reminders

Use cases:

Track conversations and agreements with employees
Document feedback and observations about team members
Set reminders for follow-up actions
Maintain a chronological record of interactions with employees

GET/employees/journal

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

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
employeeId (string): Employee ID
createdAt (date): Journal entry creation timestamp
createdBy (string): Creator user ID
mood (set): Journal entry mood
reminder (date): Reminder date

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): Journal entry ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
employeeId (string): Employee 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
employeeId: Employee ID
createdAt: Journal entry creation timestamp
createdBy: Creator user ID
mood: Journal entry mood
reminder: Reminder date

Sort Structure:

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

Default Sort: createdAt (desc)

fieldsToReturnstring[]

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

Available Fields: id, employeeId, createdAt, createdBy, mood, reminder, body

Responses

200

Paginated list of employee journal entries

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

pagequeryPage number (1-based)pageSizequeryNumber of items per pageviewIdqueryView identifier for saved grid configurationsfiltersqueryJSON string containing filter configuration. **Available Fields:** - **id** (string): Journal entry ID - **employeeId** (string): Employee 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 - **employeeId** (string): Employee 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.sortqueryJSON array of sort objects. **Sortable Fields:** - **id**: Journal entry ID - **employeeId**: Employee 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)fieldsToReturnqueryComma-separated list of field names to include in response items. If not provided, all fields are returned. **Available Fields:** id, employeeId, createdAt, createdBy, mood, reminder, body

Request

curl -X GET "https://leadtime.app/api/public/employees/journal" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

import requests

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

Response

Paginated list of employee journal entries