Retrieve Search Results

From docs
Jump to: navigation, search

Mobile_API »Load Saved Places Searches

Base URL

https://apimobile.callproof.com

Endpoint

/api/places-load

Purpose

Retrieves the authenticated user’s saved Places search criteria. Returned searches are shaped according to the company’s primary location search type (Google Places vs POI database), including name, location, and the stored filter values.

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.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/places-load' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/places-load' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Returns the list of saved Places searches for the 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 array List of saved search criteria objects
uri string Requested resource URI

data[] (common fields)

Field Type Description
id integer Unique identifier of the saved search
name string Saved search name
primary_location integer Search type indicator (1 = POI database, 2 = Google Places / Australian search type)
latitude string/number Search center latitude
longitude string/number Search center longitude
query string Keyword used in the search
address string Address filter, when saved
zip_code string ZIP/postal code filter, when saved

Additional fields (Google Places searches)

Field Type Description
google_place_category string Places category ID associated with the saved Google Places search

Additional fields (POI database searches)

Field Type Description
place_category array Category IDs used in the POI search
radius number/string Search radius
maximum_results number/string Maximum results count
employee_minimum number Minimum employee count filter
employee_maximum number Maximum employee count filter
annual_sales_minimum number Minimum annual sales filter
annual_sales_maximum number Maximum annual sales filter
employee_size_filter boolean/mixed Whether the employee-size filter was selected
annual_sales_filter boolean/mixed Whether the annual-sales filter was selected

Error Responses

Status Code Meaning
400 Bad Request – saved Places searches could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while loading saved Places searches.
  • 401 – Authentication failed or the access token is missing/expired.