Skip to content
Docs

List Notifications

The key creator's notifications in this workspace, newest first.

GET/api/v1/notifications

Requires an API key with the read scope.

Returns the notifications of the user who created the key, in the key's workspace. Notifications are kept for 90 days. Pagination is by page, with meta.hasMore telling you whether another page exists.

Query Parameters#

pageintegerquery
Page number, starting at 1. Default 1.
pageSizeintegerquery
Rows per page, 1 to 100. Default 20.
unreadbooleanquery
Only notifications that are not read yet. Default false.
categorystringquery
Comma-separated filter: replies, campaigns, inboxes, imports, billing, workspace. Several values match any of them. Leave it out for every category.

Response#

dataarray
Show Notification
idstring
Notification identifier.
typestring
What happened, for example campaign_completed, campaign_autopaused, account_disconnected, import_completed, interested_replies, payment_failed.
titlestring
One line summary.
bodystring
Detail line, or null.
hrefstring
App path the notification points to, for example /campaigns/abc, or null.
categorystring
The pill the notification belongs to: replies, campaigns, inboxes, imports, billing or workspace.
metaobject
Identifiers and counts for the event, or null.
detailsarray
What the row shows when it is expanded, at most 10 items of label, value, text, href and at (each optional except label). For interested replies one item per reply: the lead, the first line of the reply, the time and the inbox thread. Empty when there is nothing more to show.
detailsMoreinteger
How many items exist beyond the ones in details.
countinteger
How many events the row stands for. Interested replies to one campaign collapse into one row until you read it.
readboolean
Whether it has been read.
readAtstring
ISO 8601 time it was read, or null.
createdAtstring
ISO 8601 time of the event (the latest one for a grouped row).
metaobject
page, pageSize, hasMore and enabled.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: read
422page or pageSize out of range, or category has a value that is not one of the six

Rate Limit#

  • 300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 5, 2026