List in-app notifications
GET
/v1/notifications/in-appList active in-app product notifications for the authenticated client.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Active in-app notificationsapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object[] | No | — |
| data[].id | string | No | Unique identifier. |
| data[].html | string | No | Sanitizable HTML div content for the notification body. |
| data[].createdAt | string | No | ISO 8601 timestamp. |
| data[].createdBy | string | No | — |
| data[].expiresAt | string | No | — |
| data[].metadata | object | No | Free-form metadata object. |
| inboxNotifications | object[] | No | — |
| inboxNotifications[].context | object | No | — |
| inboxNotifications[].context.permissionRequest | object | No | Original proposed action, returned only by a notification detail read with current thread read access. Retained after approval or denial. Decision status and resolvedBy identity are projected into metadata.decision on the existing inbox item. |
| inboxNotifications[].context.permissionRequest.requestId | string | Yes | — |
| inboxNotifications[].context.permissionRequest.toolName | string | Yes | — |
| inboxNotifications[].context.permissionRequest.input | string | Yes | — |
| inboxNotifications[].context.permissionRequest.reason | string | No | — |
| inboxNotifications[].context.permissionRequest.permissionRing | 1 | 2 | 3 | No | — |
| inboxNotifications[].context.permissionRequest.permissionRingLabel | string | No | — |
| inboxNotifications[].context.permissionRequest.permissionActionLabel | string | No | — |
| inboxNotifications[].context.userMessage | string | No | — |
| inboxNotifications[].context.runSummary | string | No | — |
| inboxNotifications[].context.requesterId | string | No | — |
| inboxNotifications[].context.requesterName | string | No | — |
| inboxNotifications[].context.requesterAvatarUrl | string | No | — |
| inboxNotifications[].context.agentName | string | No | — |
| inboxNotifications[].context.agentAvatarUrl | string | No | — |
| inboxNotifications[].context.actorName | string | No | — |
| inboxNotifications[].context.actorAvatarUrl | string | No | — |
| inboxNotifications[].context.computerName | string | No | — |
| inboxNotifications[].context.threadId | string | No | Thread ID. |
| inboxNotifications[].context.workflowId | string | No | — |
| inboxNotifications[].context.runId | string | No | — |
| inboxNotifications[].context.resources | object[] | No | — |
| inboxNotifications[].context.resources[].id | string | Yes | Unique identifier. |
| inboxNotifications[].context.resources[].name | string | Yes | Human-readable name. |
| inboxNotifications[].context.resources[].resourceType | string | Yes | — |
| inboxNotifications[].context.resources[].mutationVerb | created | updated | No | — |
| inboxNotifications[].id | string | Yes | Unique identifier. |
| inboxNotifications[].eventId | string | Yes | — |
| inboxNotifications[].eventType | string | Yes | — |
| inboxNotifications[].recipientUserId | string | Yes | — |
| inboxNotifications[].organizationId | string | No | — |
| inboxNotifications[].preferenceKey | agentRuns | permissionRequests | assignedWork | taskActivity | invitations | productUpdates | Yes | — |
| inboxNotifications[].category | agent_runs | permission_requests | assigned_work | task_activity | invitations | product_updates | Yes | — |
| inboxNotifications[].severity | info | success | warning | error | critical | Yes | — |
| inboxNotifications[].title | string | Yes | Display title. |
| inboxNotifications[].body | string | Yes | — |
| inboxNotifications[].actionUrl | string | No | — |
| inboxNotifications[].resourceType | string | No | — |
| inboxNotifications[].resourceId | string | No | — |
| inboxNotifications[].metadata | object | Yes | Free-form metadata object. |
| inboxNotifications[].seenAt | string | No | — |
| inboxNotifications[].readAt | string | No | — |
| inboxNotifications[].dismissedAt | string | No | — |
| inboxNotifications[].archivedAt | string | No | — |
| inboxNotifications[].bookmarkedAt | string | No | Recipient bookmark timestamp. Bookmarked notifications remain in Inbox when read items are automatically removed. |
| inboxNotifications[].actedAt | string | No | — |
| inboxNotifications[].createdAt | string | Yes | ISO 8601 timestamp. |
| inboxNotifications[].updatedAt | string | Yes | ISO 8601 timestamp. |
| inboxNextCursor | string | No | — |