Skip to content
Hoursmith Docs
APIReferenceNotifications

List my notifications

List my notifications. The CALLER's own in-app notifications in this workspace, newest first. Any role, read scope. Never returns another member's notifications, and lists (and counts in unreadCount) only the rows the caller's current role and project access still cover: team-payout notifications while the caller is Owner/Admin, invoice and budget notifications while Owner/Admin/Manager, and for a Member mention, assignment and comment notifications only on projects they can still access. Hidden rows are kept and return with the access; until then they cannot be marked read. Returns unreadCount. Titles and snippets may quote teammates' text (untrusted). Unknown or repeated query parameters return 422.

GET
/notifications

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Query Parameters

unreadOnly?boolean

true = unread only. Default false.

cursor?string

Opaque cursor from pagination.nextCursor; reuse with the same unreadOnly.

limit?integer

Page size; default 50.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notifications"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "mention",      "title": "string",      "snippet": "string",      "actorId": "d2f1b55c-8cee-4a0d-af57-aebaeff77518",      "actorName": "string",      "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",      "read": true,      "readAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "appPath": "string"    }  ],  "unreadCount": 0,  "pagination": {    "limit": 1,    "nextCursor": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
Was this page helpful?