Skip to content
BuildWorkPro Docs

List notifications for the API key creator

GET
/notifications
 
curl --request GET \
  --url https://app.buildworkpro.com/api/v1/notifications \
  --header 'Authorization: Bearer <token>'

Returns the most recent notifications for the user that owns the API key. Supports filtering by type and unread state.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
limit
integer
>= 1 <= 100
offset
integer | null
type
string
unreadOnly
boolean | null

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Notifications page

Media type application/json
object
data
required
Array<object>
object
id
required
integer
tenantId
required
integer
userId
required
integer
type
required
string
title
required
string
message
required
string | null
entityType
required
string | null
entityId
required
integer | null
readAt
required
Any of:
string format: date-time
createdAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer
Example generated 
{
  "data": [
    {
      "id": 1,
      "tenantId": 1,
      "userId": 1,
      "type": "example",
      "title": "example",
      "message": "example",
      "entityType": "example",
      "entityId": 1,
      "readAt": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z"
    }
  ],
  "meta": {
    "request_id": "example",
    "pagination": {
      "cursor": "example",
      "has_more": true,
      "count": 1
    }
  }
}

403

Section titled “ 403 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}