Skip to content
ShaireDevelopers
Get a token

notifications

4 endpoints.

One of the two paged endpoints. Keep requesting while nextCursor is set: it is what tells you a feed has more behind it, and a page shorter than the limit can still have a cursor, because the cursor comes from the last row fetched rather than the last one that survived filtering.

get/api/notifications#

comments:read

Query

limitinteger
default 50 · min 1 · max 200
cursorstring
statusstring
allunreaddefault "all"
Request
curl https://api.shairelabs.com/api/notifications \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · NotificationPage

itemsobject[]*
[item]object
idstring · uuid*
typestring*
assignedcommentedmentioned
entityobject*
typestring*
ticketpagemilestonelist
idstring · uuid*
titlestring*
subtitlestring | null*
keystring | null*
listIdstring · uuid | null*
statusIdstring · uuid | null*
iconstring | null*
glyphstring | null*
subjectTypestring*
ticketmilestonepage
actorobject | null*
idstring · uuid*
namestring*
payloadobject*
[key: string]unknown
readAtstring | null*
createdAtstring*
nextCursorstring | null*

Also answers 401 and 403. SeeErrors.

post/api/notifications/read#

comments:write

Body

ids(string · uuid)[]*
Request
curl https://api.shairelabs.com/api/notifications/read \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ids":[]}'

Response · 204

Also answers 401 and 403. SeeErrors.

post/api/notifications/read-all#

comments:write
Request
curl https://api.shairelabs.com/api/notifications/read-all \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 204

Also answers 401 and 403. SeeErrors.

get/api/notifications/unread-count#

comments:read
Request
curl https://api.shairelabs.com/api/notifications/unread-count \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · UnreadCount

countinteger*

Also answers 401 and 403. SeeErrors.