List notifications

GET/workspaces/{organizationId}/notifications

Path parameters

organizationIdstringrequired

Query parameters

unreadOnlystring

Only unread notifications

snoozedOnlystring

Only snoozed notifications

includeSnoozedstring

Include snoozed notifications

limitstring

Max notifications to return

Responses

200Notifications list

notificationsobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

recipientIdstringrequired

recipientTypestringrequired

issueIdstringrequired

typestringrequired

readbooleanrequired

snoozedUntilstring | nullrequired

metadataany | null

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*unreadOnlyqueryOnly unread notificationssnoozedOnlyqueryOnly snoozed notificationsincludeSnoozedqueryInclude snoozed notificationslimitqueryMax notifications to return

Request

curl -X GET "/workspaces/string/notifications"

const response = await fetch("/workspaces/string/notifications", {
  method: "GET"
});

import requests

response = requests.get(
    "/workspaces/string/notifications",
)

Response

{
  "notifications": [
    {
      "id": "string",
      "organizationId": "string",
      "recipientId": "string",
      "recipientType": "string",
      "issueId": "string",
      "type": "string",
      "read": true,
      "snoozedUntil": "string",
      "metadata": null,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}