Skip to content
Optiwork API Docs

List notifications

GET
/notifications/central
curl --request GET \
  --url 'https://work.optidata.cloud/api/notifications/central?tab=for-me&pageSize=7&page=1&locale=pt_BR&timeZone=America%2FSao_Paulo' \
  --header 'Authorization: Bearer <token>'

The notification centre, paginated newest first. tab=for-me returns the caller’s own notifications; tab=general returns tenant-wide announcements. Each item carries a resolved_message rendered in the requested locale and time zone.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
tab
required
string
Allowed values: for-me general

Which stream to read.

pageSize
integer
default: 7 >= 1

Items per page.

page
integer
default: 1 >= 1

1-based page number.

locale
string

Locale used to render each message.

Example
pt_BR
timeZone
string
default: UTC

IANA time zone used to render dates inside messages.

Example
America/Sao_Paulo

Responses

Section titled “ Responses ”

200

Section titled “200”

A page of notifications.

Media typeapplication/json
object
pagination
required
object
current_page
required
integer
data
required
Array
first_page_url
string | null format: uri
from
integer | null
last_page

Absent on endpoints that use the simple paginator.

integer
last_page_url
string | null format: uri
links
Array<object>

Navigation links of a paginated envelope.

object
url
string | null format: uri
label
string
page
integer | null
active
boolean
next_page_url
string | null format: uri
path
string format: uri
per_page
required
integer
prev_page_url
string | null format: uri
to
integer | null
total

Absent on endpoints that use the simple paginator.

integer
data
required
Array<object>

One notification delivered to a user, or a tenant-wide announcement.

object
id
integer format: int64
uuid

Recipient. null on tenant-wide announcements.

string | null format: uuid
is_read
boolean
created_at
string format: date-time
notification

The underlying notification, enriched with a rendered message.

object
id
integer format: int64
key
string
resolved_message

Localised, plain-text rendering of the notification.

string
actor
string | null
icon
string | null
app_name
string | null
key
additional properties
any
Example
{
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "data": [
      {
        "notification": {
          "key": "drive.share.permission_created"
        }
      }
    ]
  }
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}