List notifications for the current user.

GET

/v1/notifications

const url = 'https://app.everruns.com/api/v1/notifications';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.everruns.com/api/v1/notifications

Parameters

Query Parameters

limit

integer format: int64

Maximum number of items returned in this page.

Responses

200

Success

application/json

object

data

required

Page of items returned by this query.

Array<object>

object

body

required

Plain-text summary of what happened.

string

created_at

required

Timestamp when this resource was created (RFC 3339).

string format: date-time

href

UI link that opens the resource the notification is about.

string | null

required

Prefixed public identifier. See ID Schema.

string

kind

required

Discriminator selecting the variant of this resource.

string

occurrence_count

required

How many times the same event recurred into this notification.

integer format: int32

payload

required

Kind-specific structured detail.

object

source

One of:

object
null

What sent the notification. Absent on notifications written before senders were recorded.

object

Public ID of the sender, when it has one.

string | null

name

Display name of the sender.

string | null

type

required

agent or system.

string

target_id

Prefixed public identifier of the resource the notification is about.

string | null

target_type

Kind of resource the notification is about, when it has one.

string | null

title

required

Human-readable title. Safe to render in user-facing messages.

string

updated_at

required

Timestamp when this resource was last updated (RFC 3339).

string format: date-time

viewed_at

When the current user marked the notification as viewed; null while unviewed.

string | null format: date-time

unviewed_count

required

Number of notifications the current user has not viewed yet.

integer format: int32

Example

{
  "data": [
    {
      "href": "/chat/session_01933b5a00007000800000000000001",
      "id": "notification_01933b5a00007000800000000000001",
      "kind": "health.issue",
      "occurrence_count": 1,
      "source": {
        "id": "agent_01933b5a00007000800000000000001",
        "name": "Platform Assistant",
        "type": "agent"
      },
      "target_id": "session_01933b5a00007000800000000000001",
      "target_type": "session",
      "title": "Agent run failed"
    }
  ],
  "unviewed_count": 3
}