Ashley DeBon: /* Request Body */

2026-07-16T07:48:26Z

‎Request Body

Ashley DeBon: Created page with "== Retrieve Followup Recommendations == === Base URL === https://apimobile.callproof.com === Endpoint === /api/followup-recommendations === Purpose === Returns suggested co..."

2026-07-16T05:02:57Z

Created page with "== Retrieve Followup Recommendations == === Base URL === https://apimobile.callproof.com === Endpoint === /api/followup-recommendations === Purpose === Returns suggested co..."

New page

== Retrieve Followup Recommendations ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/followup-recommendations

=== Purpose ===
Returns suggested contacts that the signed-in user should follow up with. When there are pending follow-up suggestions, the response provides contact information to help the user take the next step. When there are no pending suggestions, the response instead provides motivational or congratulatory content so the user still receives a meaningful result on the follow-up recommendations screen.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| latitude || string || No || Not specified in Swagger
|-
| longitude || string || No || Not specified in Swagger
|}

==== Path Parameters ====
None.

==== Request Body ====
None.

=== Successful Response (200) ===
Indicates that follow-up recommendations (or related placeholder content) were retrieved successfully for the authenticated user.

Response field details are not defined in Swagger. Based on the API behavior, a successful response typically includes:

{| class="wikitable"
! 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 || Payload containing the recommendation result
|-
| data.state || integer || Recommendation state: 1 = no pending recommendations (motivational content), 2 = pending recommendations available (contact suggestions), 3 = recommendations already acted on (congratulatory content)
|-
| data.recommendation || array || List of recommendation items. For pending recommendations, each item contains contact details plus follow-up context such as the last contacted representative name and previous notes. When no pending recommendations remain, items may contain image URLs used for motivational or congratulatory display
|-
| uri || string || Requested resource URI
|}

Detailed field schemas for individual contact objects within <code>data.recommendation</code> are Not specified in Swagger.

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Successful request (documented in Swagger)
|-
| 201 || Documented in Swagger as a successful create response; not typically applicable to this GET endpoint
|-
| 204 || Documented in Swagger as a successful response with no content; not typically applicable to this GET endpoint
|-
| 301 || Documented in Swagger as a permanent redirect; not typically applicable to this GET endpoint
|-
| 400 || Bad Request – the request could not be completed successfully
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|-
| 403 || Not specified in Swagger
|-
| 404 || Not specified in Swagger
|-
| 422 || Not specified in Swagger
|-
| 500 || Not specified in Swagger
|}

* '''400''' – The service could not return follow-up recommendations for the request.
* '''401''' – Authentication failed or the access token is missing/expired.
* '''403 / 404 / 422 / 500''' – Not specified in Swagger for this endpoint.

@@ Line 39: / Line 39: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Retrieve the Followup Recommendations - Revision history

Ashley DeBon: /* Request Body */

Ashley DeBon: Created page with "== Retrieve Followup Recommendations == === Base URL === https://apimobile.callproof.com === Endpoint === /api/followup-recommendations === Purpose === Returns suggested co..."