Notifications API: List

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/notifications/list
Handler	OperatelyWeb.Api.Notifications.List

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
page	integer	No	No	-
per_page	integer	No	No	-

Outputs#

Field	Type	Required	Nullable
notifications	array of notification object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/notifications/list?page=123&per_page=123" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "notifications": [
    {
      "__typename": "value",
      "activity": "<activity>",
      "id": "value",
      "inserted_at": "2026-01-01T09:30:00Z",
      "read": true,
      "read_at": "2026-01-01T09:30:00Z"
    }
  ]
}