Ashley DeBon: /* Successful Response (200) */

2026-07-20T14:14:16Z

‎Successful Response (200)

Ashley DeBon: /* Get Place Menu List */

2026-07-20T14:13:40Z

‎Get Place Menu List

Ashley DeBon: Created page with "== Get Place Menu List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/place-menu/{place_id} === Purpose === Retrieves the dynamic menu actions av..."

2026-07-20T14:11:48Z

Created page with "== Get Place Menu List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/place-menu/{place_id} === Purpose === Retrieves the dynamic menu actions av..."

New page

== Get Place Menu List ==

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

=== Endpoint ===
/api/place-menu/{place_id}

=== Purpose ===
Retrieves the dynamic menu actions available for a Google Place. The menu can include event forms, custom contact menu items (based on the user’s configured contact menu list), and an “Add to my CallProof” action when the place is not yet linked to a contact.

=== HTTP Method ===
GET

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

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

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| place_id || string/integer || Yes || Place identifier used to load the place and any related CallProof contact
|}

==== Query Parameters ====
None.

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

=== Successful Response (200) ===
Returns the place menu configuration for the authenticated user.

{| 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 || Place menu payload
|-
| uri || string || Requested resource URI
|}

==== data ====
{| class="wikitable"
! Field !! Type !! Description
|-
| list_name || string || Name of the user’s contact menu list
|-
| is_contact_done || boolean || <code>true</code> if the place already has a linked CallProof contact; otherwise <code>false</code>
|-
| dynamic_contact_menu || array || Menu items available for this place
|}

==== data.dynamic_contact_menu[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| title || string || Menu item display name
|-
| regular_id || integer/string || Action/type identifier for the menu item
|-
| account_id || string/integer || Account identifier when applicable (for example, GlassUSA); otherwise a default empty/account value
|-
| event_form_id || integer/string || Event form ID when the item is an event form; otherwise <code>0</code>
|-
| treat_as || boolean/string || Treat-as flag for the menu action
|-
| redirection_url || string || Redirection URL for the menu action, when configured
|-
| valid_id || integer/string || Validity indicator for the menu item
|-
| error_message || string || Error text when an event form cannot be used for the contact type; empty when valid
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – place menu could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – An error occurred while loading the place menu (for example, "Error while retriving the Places Menu").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 14:13, 20 July 2026
Line 1:		Line 1:
−	== Get Place Menu List ==	+	== [[Mobile_API]] »Get Place Menu List ==

	=== Base URL ===		=== Base URL ===

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

Get Places Menu List - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Get Place Menu List */

Ashley DeBon: Created page with "== Get Place Menu List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/place-menu/{place_id} === Purpose === Retrieves the dynamic menu actions av..."