User ToolTip

Mobile_API »Get User Tooltip Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/user-tooltip

Purpose

Retrieves the authenticated user’s in-app tooltip/onboarding stage flags (which screens still show tips). If no tooltip record exists yet, all tip flags are returned as disabled (`false`).

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 the user’s tooltip stage flags.

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	Tooltip stage flags
uri	string	Requested resource URI

data

Field	Type	Description
has_tooltip_enable	boolean	Whether tooltips are enabled overall
home_screen	boolean	Whether the home screen tip is active
accounts_screen	boolean	Whether the accounts screen tip is active
route_screen	boolean	Whether the route screen tip is active
places_screen	boolean	Whether the places screen tip is active
places_filter_screen	boolean	Whether the places filter screen tip is active
home_settings_screen	boolean	Whether the home settings screen tip is active

Error Responses

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

• 400 – An error occurred while loading tooltip details (for example, "Error while retriving the Users List").
• 401 – Authentication failed or the access token is missing/expired.