Read notification preferences

GET/v1/notifications/preferences

Read the authenticated user's event-category notification preferences.

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.

200Current notification preferencesapplication/json
FieldTypeRequiredDescription
preferencesobjectYes
preferences.agentRunsbooleanYesNotify about completion and failure of threads, schedules, and triggers.
preferences.permissionRequestsbooleanYesNotify when an agent needs approval or additional tool access.
preferences.assignedWorkbooleanYesNotify about human task assignments and review requests.
preferences.taskActivitybooleanYesNotify about activity on subscribed project tickets.
preferences.invitationsbooleanYesNotify about team and organization invitations.
preferences.productUpdatesbooleanYesShow product announcements and release information.
401Authentication required
None.
Read notification preferences
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow