Get Places Menu List

Mobile_API »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

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

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.

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

Field	Type	Description
list_name	string	Name of the user’s contact menu list
is_contact_done	boolean	true if the place already has a linked CallProof contact; otherwise false
dynamic_contact_menu	array	Menu items available for this place

data.dynamic_contact_menu[]

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 0
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

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.