API referenceNotifications
List
Authorization
apiKey AuthorizationBearer <token>
Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
workspaceId*string
Query Parameters
limit?string|null
unreadOnly?string|null
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/notifications"{ "data": { "notifications": [ { "id": "string", "workspaceId": "string", "recipientUserId": "string", "actorUserId": "string", "actorDisplayName": "string", "actorAvatarUrl": "string", "kind": "comment", "surfaceId": "string", "itemId": "string", "blockId": "string", "commentId": "string", "preview": "string", "surfaceTitle": "string", "readAt": "string", "createdAt": "string" } ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}