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

2026-07-20T14:05:10Z

‎Successful Response (200)

Ashley DeBon: /* Get Nearest Places */

2026-07-20T14:04:35Z

‎Get Nearest Places

Ashley DeBon: Created page with "== Get Nearest Places == === Base URL === https://apimobile.callproof.com === Endpoint === /api/places === Purpose === Searches for nearby places around a location (latitud..."

2026-07-20T14:04:22Z

Created page with "== Get Nearest Places == === Base URL === https://apimobile.callproof.com === Endpoint === /api/places === Purpose === Searches for nearby places around a location (latitud..."

New page

== Get Nearest Places ==

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

=== Endpoint ===
/api/places

=== Purpose ===
Searches for nearby places around a location (latitude/longitude, address, and/or ZIP code). Results can be filtered by keyword and category, support Google Places page tokens for additional results, and include distance from the user’s current location.

=== HTTP Method ===
POST

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

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

=== Parameters ===

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

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| page || integer || No || Page number used when building next-page navigation URLs
|}

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| latitude || number/string || No || Search latitude. Used with longitude, or derived from address/ZIP when provided
|-
| longitude || number/string || No || Search longitude. Used with latitude, or derived from address/ZIP when provided
|-
| address || string || No || Address used to resolve latitude/longitude for the search
|-
| zip_code || string || No || ZIP/postal code used when address is empty to resolve location
|-
| keyword || string || No || Free-text search keyword (for example, business name)
|-
| category_id || string/integer || No || Place category identifier used to filter by business type
|-
| next_page_token || string || No || Token from a previous response to fetch the next set of places
|}

=== Successful Response (200) ===
Returns a paginated list of nearby places.

{| 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 || array || List of place records (see below)
|-
| firstItemOnPage || integer || Index of the first item on the current page
|-
| lastItemOnPage || integer || Index of the last item on the current page
|-
| hasNextPage || boolean || Whether a next page is available
|-
| hasPreviousPage || boolean || Whether a previous page is available
|-
| isFirstPage || boolean || Whether the current page is the first page
|-
| isLastPage || boolean || Whether the current page is the last page
|-
| next_page_url || string/null || URL of the next page, when available
|-
| prev_page_url || string/null || URL of the previous page, when available
|-
| first_page_url || string || URL of the first page
|-
| last_page_url || string || URL of the last page
|-
| pageCount || integer || Total number of pages
|-
| pageNumber || integer || Current page number
|-
| pageSize || integer || Number of items per page (typically 20)
|-
| totalItemCount || integer || Total number of matching items
|-
| next_page_token || string || Token to request the next batch of places, when available
|-
| uri || string || Requested resource URI
|}

==== data[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| id || integer || Unique identifier of the place record
|-
| name || string || Place / business name
|-
| address || string || Street address
|-
| city || string || City
|-
| state || string || State abbreviation
|-
| zip || string || ZIP/postal code
|-
| phone_number || string || Formatted phone number, when available
|-
| latitude || string || Place latitude
|-
| longitude || string || Place longitude
|-
| distance || string || Distance from the user (for example, <code>1.25 M</code>)
|-
| record_color || string || Display color indicator for the place record
|-
| website || string || Website URL, when available
|-
| type || string || Place source type (for example, <code>g</code> for Google Places)
|}

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

* '''400''' – Places lookup failed (for example, "Error while Retrieving Places" or "Error while retriving the places list").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 14:04, 20 July 2026
Line 1:		Line 1:
−	== Get Nearest Places ==	+	== [[Mobile_API]] »Get Nearest Places ==

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

@@ Line 53: / Line 53: @@
 | next_page_token || string || No || Token from a previous response to fetch the next set of places
 |}
 === Successful Response (200) ===

Get Nearest Places Details - Revision history

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

Ashley DeBon: /* Get Nearest Places */

Ashley DeBon: Created page with "== Get Nearest Places == === Base URL === https://apimobile.callproof.com === Endpoint === /api/places === Purpose === Searches for nearby places around a location (latitud..."