Get user notifications

Returns a paginated list of notifications for the current user.

What are Notifications? Notifications inform users about important events in the system:

Project updates
Task assignments
Vacation request approvals/rejections
Comments and mentions
System announcements
And more…

What is returned:

Notification type and entity information
Human-readable message
Read/unread status
Creation date
Creator information

Query parameters:

unreadOnly: Set to true to return only unread notifications

Note: Supports server-side pagination, sorting, and filtering via grid query parameters.

GET/account/notifications

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): Notification ID - **type** (set): Notification type - **entity** (string): Related entity type - **entityId** (string): Related entity ID - **creatorId** (string): Creator user ID - **isRead** (boolean): Read status - **createdAt** (date): Creation timestamp **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): Notification ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **type** (set): Notification type (set filter). Available comparisons: in, not_in, is_empty, is_not_empty - **entity** (string): Related entity type (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **entityId** (string): Related entity ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **creatorId** (string): Creator user ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **isRead** (boolean): Read status (boolean filter). Available comparisons: equal, not_equal - **createdAt** (date): Creation timestamp (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**: Notification ID - **type**: Notification type - **entity**: Related entity type - **entityId**: Related entity ID - **creatorId**: Creator user ID - **isRead**: Read status - **createdAt**: Creation timestamp **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, type, entity, entityId, creatorId, isRead, createdAt, message

Responses

200Paginated notifications with human-readable messages

itemsobject[]

Show properties

Array of object

createdAtstring<date-time>

creatorIdstring

entitystring

entityIdstring

idstring

isReadboolean

messagestring

Human-readable message

typestring

pagenumber

pageSizenumber

totalnumber

400Validation errors

errorsobject

Show properties

unreadOnlystring[]

messagestring

statusCodenumber

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

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

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

import requests

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

Response

{
  "items": [
    {
      "createdAt": "2024-01-01T00:00:00Z",
      "creatorId": "string",
      "entity": "string",
      "entityId": "string",
      "id": "string",
      "isRead": true,
      "message": "string",
      "type": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0
}