User Notification Settings

Get User Notification Settings

Base URL

https://apimobile.callproof.com

Endpoint

/api/user-notification-settings

Purpose

Retrieves the authenticated user’s notification preferences. Each notification type is returned as an enabled/disabled flag (defaults to enabled when no personal setting exists), along with available task/device notification timing choices and the currently selected option.

HTTP Method

GET

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns notification type toggles and device notification timing choices.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
user_id	integer	Identifier of the authenticated user
company_id	integer	Identifier of the authenticated user’s company
data	object	Notification settings payload
uri	string	Requested resource URI

data

Field	Type	Description
video_message_notification	boolean	Whether video message notifications are enabled
video_message_email_notification	boolean	Whether video message email notifications are enabled
callproof_academy_notification	boolean	Whether CallProof Academy notifications are enabled
allow_outside_video_messages	boolean	Whether outside video messages are allowed
device_notification	object	Device/task notification timing details (see below)

Additional notification-type keys may appear based on configured notification types. When a user has no saved preference for a type, the value defaults to true (enabled).

data.device_notification.choices[]

Field	Type	Description
task_notification_choice_id	integer	Unique identifier of the notification timing choice
name	string	Display name of the choice
value	integer/string	Timing value for the choice
selected	boolean	true when this is the user’s currently selected timing option

Error Responses

Status Code	Meaning
400	Bad Request – notification settings could not be retrieved
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – An error occurred while loading notification settings (for example, "Error while retrieving the user notification settings details").
• 401 – Authentication failed or the access token is missing/expired.