v1
latestOpenAPI 3.1.02026-07-24770322.0 KBList Notifications
Lists notifications for a workspace.
get/v1/notifications
Query parameters
recipientIdstring
Deprecated in favor of recipientClientId and recipientInternalUserId
includeReadboolean
Includes read notifications.
recipientClientIdstring
ID of the client to fetch notifications for.
recipientInternalUserIdstring
ID of the client to fetch notifications for.
Response
200
Example response
{
"data": [
{
"createdAt": "2024-02-23T18:52:54.338474874Z",
"deliveryTargets": {
"inProduct": {
"title": "Invoice was paid",
"ctaParams": {
"foo": "bar"
}
}
},
"event": "invoice.paid",
"id": "dc0f1749-7d01-48b7-bd80-fcbfce835642:in_1On3rOFdviIHOKAnf02di30Z",
"object": "notification",
"recipientId": "dc0f1749-7d01-48b7-bd80-fcbfce835642",
"recipientClientId": "dc0f1749-7d01-48b7-bd80-fcbfce835642",
"recipientCompanyId": "dc0f1749-7d01-48b7-bd80-fcbfce835642",
"recipientInternalUserId": "dc0f1749-7d01-48b7-bd80-fcbfce835642",
"resourceId": "in_1On3rOFdviIHOKAnf02di30Z",
"senderId": "e960feb9-3b49-45b5-8e15-9202acced3ac",
"senderType": "client"
}
]
}