GET /api/notifications

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.

Request

Parameter	Location	Type and requirement
`limit`	query	string · optional

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)

curl --include \
  --request GET \
  'https://api.weavers.app/api/notifications' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "items": [],
  "unreadCount": 1
}

View response model

items required · array of object

View items model

Array items:

id required · number

status required · "unread" | "read"

createdAt required · string

readAt required · null | string

View readAt model

Variant 1: null

null

Variant 2: string

string

presentation required · object

View presentation model

messageKey required · string

reasonLabel required · string

messageParams required · object

View messageParams model

Additional fields: JSON value.

Additional fields: JSON values.

event required · object

View event model

id required · number

actorId required · null | number

View actorId model

Variant 1: null

null

Variant 2: number

number

eventType required · string

objectId required · null | string

View objectId model

Variant 1: null

null

Variant 2: string

string

metadata required · object

View metadata model

Additional fields: JSON value.

createdAt required · string

Additional fields: JSON values.

unreadCount required · number

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data

{
  "error": "example"
}

View response model

error required · string

Additional fields: JSON values.