Read the caller's notification feed (flat, newest first)

GET

/v1/notifications

const url = 'http://localhost:3000/v1/notifications?limit=20';
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 'http://localhost:3000/v1/notifications?limit=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

next

string

Opaque paging token. Pass the next value from the previous page.

owner

string

Server token only — the user whose feed to read.

Responses

200

A page of notifications plus unseen/unread counts.

application/json

object

results

required

Array

next

required

Opaque cursor. Null when no further page.

string | null

results

required

Array<object>

object

required

string format: uuid

verb

required

string

Allowed values: follow react

actor

required

string

object

required

Follow: the followed feed ref; react: the activity id

string

reaction_kind

required

string | null

created_at

required

string format: date-time

seen_at

required

string | null format: date-time

read_at

required

string | null format: date-time

actor_user

required

Enriched from users.custom when actor parses as user:. Null otherwise.

object

string

custom

object

key

additional properties

any

unseen

required

integer

unread

required

integer

Example

{
  "results": [
    {
      "verb": "follow",
      "actor": "user:bob"
    }
  ]
}

401

Invalid, expired, revoked, or absent token.

application/json

object

error

required

object

code

required

string

Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL

message

required

string

requestId

required

string

fields

Present only for VALIDATION_FAILED.

Array<object>

object

path

string

message

string

Example

{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

code

required

string

Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL

message

required

string

requestId

required

string

fields

Present only for VALIDATION_FAILED.

Array<object>

object

path

string

message

string

Example

{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}

429

Rate limit exceeded.

application/json

object

error

required

object

code

required

string

Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL

message

required

string

requestId

required

string

fields

Present only for VALIDATION_FAILED.

Array<object>

object

path

string

message

string

Example

{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}

Headers

Retry-After

integer