Notifications

List notifications

Returns your company's in-app notifications, newest first, a page at a time. The Speak app shows the same list under Notifications.

Who sees what

An owner sees every notification in the company. A member of one or more user groups sees their own notifications, the ones written for the people in those groups, and the ones assigned to those groups. Anyone else sees every notification in the company. filterUserId narrows the list to one person.

totalUnReadCount always counts only your own unread notifications, whatever filters you send.

Categories and actions

type is the category of a notification and action is what happened. Send either as a filter. An unknown type is ignored and returns every category, while an unknown action matches nothing.

Labels and comments

  • Label library: creating, editing, archiving, restoring or merging a label, or adding Speak label sets, writes type label with mediaType label for the person who made the change. mediaId holds the labelId.
  • Labels on a transcript: applying, changing or removing labels writes type label with actions created, updated or deleted. mediaId and mediaType name the file.
  • Comments: adding, editing, resolving, reopening or deleting a comment writes type comment for the person who did it, with actions created, updated, resolved, reopened or deleted.
  • Thread starters: the person who started a thread also gets a comment notification when someone else replies (replied), resolves it (resolved) or reopens it (reopened). They are not told about their own replies, and people who are no longer active members are not told.
  • Dashboard share links: turning labels or comments on or off on a dashboard's share link, or changing its modes or reviewer names, writes type dashboard with mediaType dashboard, and mediaId holds the dashboardId.

Changes made through a dashboard share link are written for the link's owner and end with "by <name> from a shared dashboard".

get/notification

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/notification
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Query parameters

pageinteger

Page to return, counting from 0. Leave it out for the first page.

pageSizeinteger

Notifications per page. Leave it out for 50.

type'clip' | 'audio' | 'account' | 'automation' | 'embed' | 'integration' | 'magic prompt' | 'media' | 'payment' | 'presentation' | 'recorder' | 'survey' | 'subscription' | 'team' | 'text' | 'transcription' | 'translate' | 'video' | 'zapier' | 'meeting assistant' | 'google calendar' | 'outlook calendar' | 'auto reload' | 'folder' | 'fields' | 'assistant template' | 'knowledge base' | 'label' | 'comment' | 'dashboard'

Only this category. One of the type values listed in the response schema, such as label, comment or dashboard. Any other value is ignored.

action'analyzed' | 'created' | 'credit' | 'debit' | 'deleted' | 'export' | 'paid' | 'updated' | 'uploaded' | 'error' | 'failed' | 'cloned' | 'replied' | 'archived' | 'restored' | 'merged' | 'resolved' | 'reopened'

Only this action, such as replied, resolved or reopened. Matched exactly.

descriptionstring

Text to look for in the description, ignoring case.

filterUserIdstring

Only notifications written for this user id.

startDatestring date-time

Start of a date range on createdAt. Applied only together with endDate.

endDatestring date-time

End of a date range on createdAt. Applied only together with startDate.

sortBy'createdAt' | 'description' | 'type' | 'isRead'

Field to sort by. Leave it out to sort by createdAt, newest first. Any other value is ignored.

sortDir'asc' | 'desc'

asc for ascending. Anything else sorts descending.

Response

Success

status'success'

success on every 2xx response.

Changes

No recorded changes to this operation across all 2 revisions of this API.