List in-app notifications for the current user

GET

/v1/users/me/notifications

curl --request GET \
  --url 'https://example.com/v1/users/me/notifications?unread_only=false&limit=20' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Tenant-ID

required

string format: uuid

Query Parameters

unread_only

boolean

limit

integer

default: 20 <= 100

cursor

string

Responses

200

OK

Media type application/json

object

items

required

Array<object>

object

id

required

string format: uuid

event_type

required

string

title

required

string

body

required

string

resource_type

string

nullable

resource_id

string format: uuid

nullable

read_at

string format: date-time

nullable

created_at

required

string format: date-time

unread_count

required

integer

has_more

required

boolean

next_cursor

string

nullable

Example ^generated

{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "event_type": "example",
      "title": "example",
      "body": "example",
      "resource_type": "example",
      "resource_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "read_at": "2026-04-15T12:00:00Z",
      "created_at": "2026-04-15T12:00:00Z"
    }
  ],
  "unread_count": 1,
  "has_more": true,
  "next_cursor": "example"
}

401

Unauthorized

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}