Notifications

/api/notifications

Your own notifications, as your notifications panel shows them. An API key or a connected app reads only notices about the projects and libraries it reaches, and never account notices.

Endpoints

GET /api/notifications

Your own notifications, newest first, as your notifications panel shows them: each item carries id, event_type, label, rendered_title, rendered_body, rendered_deep_link, created_at, read_at, tier, settled and needs_you. Returns { items, next_cursor }; pass next_cursor back as cursor for the next page. Reading the list marks nothing read. Signed in to SynC, you read your whole list. With an API key or a connected app you read only notifications about the projects and libraries the key reaches, and never account notices: sign-in and security, legal, billing, company membership, roles, seats, or your own contribution record. The unread count agrees with the list for the same key.

Signed in · your own account only

Parameters
NameInTypeDescription
limitqueryintegerItems per page, 1 to 100. Default 25.
cursorquerystringThe next_cursor of the previous page (a notification id).
unread_onlyquerybooleantrue to list unread notifications only.
needs_youquerybooleantrue to list only notifications that wait on a decision from you.
scopequerystring'all' (default), 'project' (with project_id) or 'non_project' (company and account notices).
project_idqueryintegerWith scope 'project': only notifications about this project.