List comment notifications
Lists the comment threads the user is subscribed to, newest activity first, each with the user's subscription and unread state and a summary of the thread's latest entry. The list is paged: when there are more threads than the page holds, the result carries a cursor to pass with the next request. Threads on records the user can no longer see are left out.
Request
GET https://www.activityinfo.org/resources/notifications/comments
Successful response
application/json
| object | |||
| notifications | array[object] | The page's notifications, newest activity first. | required |
| notification | object | The user's notification for the thread: their subscription, their unread state and a summary of the thread's latest entry. | required |
| formId | string | The id of the form of the record the thread is attached to. | required |
| recordId | string | The id of the record the thread is attached to. | required |
| fieldId | string | The id of the field the thread is about, or `_record` for a thread on the record as a whole. | required |
| threadId | string | The id of the thread. | required |
| databaseId | string | The id of the database the form belongs to. | required |
| userId | string | The id of the user the notification is for. | required |
| subscribed | boolean | True if the user is notified of activity in the thread. | required |
| unread | boolean | True if the thread has activity the user has not yet seen. | required |
| resolved | boolean | True if the thread is resolved, as copied from the thread. | required |
| lastActivityTime | instant | The time of the thread's latest entry, as copied from the thread. | required |
| lastAuthorId | string | The id of the author of the thread's latest entry, as copied from the thread. | optional |
| lastCommentPreview | string | The first 200 characters of the thread's latest comment, as copied from the thread. | optional |
| commentCount | integer | The number of entries in the thread, as copied from the thread. | required |
| recordLabel | string | The record's label as the user sees it, or absent if the record has no label. | optional |
| users | array[object] | The users the notifications refer to, such as the authors of the latest entries, so that the client can show names without a lookup. | required |
| id | string | The user's id. | required |
| name | string | The user's full name. | required |
| string | The user's email address. | required | |
| cursor | string | Passed back as the `cursor` parameter to fetch the next page. Absent on the last page. | optional |
Error responses
| Status Code | Error Code | Description |
|---|---|---|
| 401 | AUTHENTICATION_ |
The request must be authenticated |
Example
curl -u anything:YOUR_API_TOKEN \
https://www.activityinfo.org/resources/notifications/comments