Notifications API

5 operations. Authentication, errors and pagination work as described in the REST API overview.

Your notifications

GET/api/v1/notificationsToken required

Newest first (keyset cursor), each with text, snippet, href and kind; unread is the unread count.

listNotifications parameters
Name	Type	Description
`cursor` query	`string`
`unread` query	`"0" \| "1" \| "true" \| "false"`
`kind` query	`"conversation" \| "social" \| "content" \| "moderation" \| "system"`
`limit` query	`integer (1–100)`

Responses: 200 OK400, 401, 403, 404, 429

Response fields

listNotifications response fields
Name	Type	Description
`items`required	`object[]`
`nextCursor`required	`string \| null`	Opaque cursor for the next page; null at the end
`unread`required	`integer (-9007199254740991–9007199254740991)`

Example

curl 'https://incantory.ai/api/v1/notifications' \
  -H "Authorization: Bearer $INCANTORY_TOKEN"

Unread count (0 when signed out)

GET/api/v1/notifications/countToken optional

Responses: 200 OK400, 404, 429

Response fields

notificationCount response fields
Name	Type	Description
`unread`required	`integer (-9007199254740991–9007199254740991)`

Example

curl 'https://incantory.ai/api/v1/notifications/count' \
  -H "Authorization: Bearer $INCANTORY_TOKEN"

Mark notifications read (or unread)

POST/api/v1/notifications/readToken required

Request body

Type: object

Responses: 200 OK400, 401, 403, 404, 429

Response fields

markNotifications response fields
Name	Type	Description
`updated`required	`integer (-9007199254740991–9007199254740991)`
`unread`required	`integer (-9007199254740991–9007199254740991)`

Example

curl -X POST 'https://incantory.ai/api/v1/notifications/read' \
  -H "Authorization: Bearer $INCANTORY_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"all":true}'

Unsubscribe confirmation page (HTML)

GET/api/v1/notifications/unsubscribePublic

unsubscribePage parameters
Name	Type	Description
`u` queryrequired	`string`
`t` queryrequired	`string`

Responses: 200 OK400, 404, 429

Example

curl 'https://incantory.ai/api/v1/notifications/unsubscribe'

One-click unsubscribe from notification email (RFC 8058)

POST/api/v1/notifications/unsubscribePublic

Authenticated by the signed link from the digest email.

unsubscribe parameters
Name	Type	Description
`u` queryrequired	`string`
`t` queryrequired	`string`

Responses: 200 OK400, 403, 404, 429

Response fields

unsubscribe response fields
Name	Type	Description
`unsubscribed`required	`true`

Example

curl -X POST 'https://incantory.ai/api/v1/notifications/unsubscribe'