USusekaneo
Notifications

List notifications

Changed on

Get up to 50 notifications for the current user, read and unread. Resource notifications require current read permission and API key scope. Optionally limit them to one workspace before applying the limit.

get/notification

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/notification
  • Auth
    HTTP bearer

Query parameters

workspaceIdstring

Limit notifications to resources currently in this workspace, plus user-wide notifications with no resource. Omit to include all workspaces.

Response

List of notifications

idstring required
userIdstring required
titlestring nullable required
contentstring nullable required

Free-text body. Null for generated notifications, whose text the client renders from type and eventData.

typestring required

One of: info, task_created, workspace_created, task_status_changed, task_assignee_changed, time_entry_created, due_date_reminder, task_overdue, task_mention, task_comment.

eventDataunknown
isReadboolean nullable required
resourceIdstring nullable required

The id of the task or workspace the notification points at.

resourceTypestring nullable required

task or workspace.

createdAtstring date-time required
updatedAtstring date-time required

Changes

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 2ed51b8af657Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      added the non-success response with the status