Difference between revisions of "Get Places Category"

From docs
Jump to: navigation, search
(Get Place Categories)
(Successful Response (200))
 
Line 33: Line 33:
 
==== Request Body ====
 
==== Request Body ====
 
None.
 
None.
 +
 +
=== cURL Example for Android ===
 +
 +
<pre> curl --location 'https://apimobile.callproof.com/api/place-category' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
 +
 +
=== cURL Example for iOS ===
 +
 +
<pre> curl --location 'https://apimobile.callproof.com/api/place-category' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===

Latest revision as of 14:03, 20 July 2026

Mobile_API »Get Place Categories

Base URL

https://apimobile.callproof.com

Endpoint

/api/place-category

Purpose

Retrieves the list of place categories available for the authenticated user’s company. If the company uses the Australian/primary location search type, Google Places categories are returned; otherwise company-configured place categories are returned (or a default category list when the company has none configured).

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/place-category' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

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

Successful Response (200)

Returns the place category list.

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 category payload
uri string Requested resource URI

data.places_category[]

Field Type Description
place_category_id integer Unique identifier of the place category
place_name string Display name of the place category
place_position integer Display/sort order of the category

Error Responses

Status Code Meaning
400 Bad Request – place categories could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while loading place categories (for example, "Error while retriving the Places Category List").
  • 401 – Authentication failed or the access token is missing/expired.