OpenRows Get started
Docs menu

API reference

Notifications

6 operations, generated from the OpenAPI document.

Your notifications, newest first (only records you can still read)

GET /api/notifications

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

NameInTypeRequired
limitqueryintegerno
cursorquerystringno
unreadquery"true" | "false"no

Responses

  • 200 Success
    • notifications array of object required
      • id string (uuid) required
      • kind "mention" | "reply" | "assigned" required
      • actorId string (uuid) | null required
      • actorName string required
      • workspaceId string (uuid) required
      • baseId string (uuid) required
      • tableId string (uuid) required
      • recordId string (uuid) required
      • commentId string (uuid) | null required
      • fieldId string (uuid) | null required
      • baseName string required
      • tableName string required
      • recordName string required
      • fieldName string | null required
      • excerpt string | null required
      • createdAt string (date-time) required
      • readAt string (date-time) | null required
    • nextCursor string | null required
    • unread integer required
  • 401 Not signed in
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)

How many of your notifications are unread

GET /api/notifications/unread

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

  • 200 Success
    • unread integer required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Mark one of your notifications read

POST /api/notifications/{notificationId}/read

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

NameInTypeRequired
notificationIdpathstring (uuid)yes

Responses

  • 200 Success
    • unread integer required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Mark all your notifications read

POST /api/notifications/read

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

  • 200 Success
    • unread integer required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Which notifications you get by email

GET /api/me/notification-preferences

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

  • 200 Success
    • email "all" | "mentions" | "none" required
    • frequency "immediately" | "hourly" | "daily" required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Choose which notifications you get by email (all, mentions only, none) and when (immediately, hourly or daily digests)

PUT /api/me/notification-preferences

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Request body

  • email "all" | "mentions" | "none"
  • frequency "immediately" | "hourly" | "daily"

Responses

  • 200 Success
    • email "all" | "mentions" | "none" required
    • frequency "immediately" | "hourly" | "daily" required
  • 401 Not signed in
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)