List user notifications

GET

/notifications

const url = 'https://example.com/api/notifications?limit=100';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://example.com/api/notifications?limit=100' \
  --header 'Authorization: Bearer <token>'

Returns recent notifications for the authenticated user. Supports ?since for polling.

Authorizations

bearerApiKey
cookieAuth

Parameters

Query Parameters

since

string format: date-time

limit

integer

default: 100 <= 200

Responses

200

Notification list

application/json

object

notifications

Array<object>

object

string format: uuid

type

string

ticket_id

string format: uuid

ticket_number

integer

ticket_title

string

project_id

string format: uuid

actor

string

detail

object

read

boolean

created_at

string format: date-time

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean