API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/notifications

ark.list_notifications

Lists notifications for the connected user. Use group_by_load=true to include spot quote/load grouped notifications.

Availability: Expanded preview
Scopes: notifications:read
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

include_readqueryboolean: default: false
group_by_loadqueryboolean: default: false
limitqueryinteger: default: 50; min: 1; max: 100

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/notifications' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Connected-user notifications

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.itemsarray<object>required

data.unreadCountintegerrequired

min: 0

data.groupsarray<object>

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied