/v1/login/search/settings

Retrieves login search settings for a specific business and region.

Purpose

Use this endpoint to determine how the system should behave when searching for clients during login/check-in flows for a given region and business.

Method & URL

Method: GET

Path: /v1/login/search/settings

Query Parameters

id_region (integer, required)

Identifies the geographic or logical region the settings apply to.

Example: 2.

k_business (integer, required)

Unique identifier of the business.

Example: 49197.

Authentication

Expects a valid authentication context (e.g., bearer/session token) to be present.

The request uses the TOKEN variable; ensure it is set appropriately in your active environment or inherited auth.

If authentication is missing or invalid, the server may return a 4xx error (such as 401 Unauthorized or 403 Forbidden).

Successful Response (200 OK)

A successful call returns JSON with the following fields (example shown from the active response):

{
  "is_auto_check_in": null,
  "is_franchisee_search_wide": false,
  "is_inactive": false,
  "is_show_client_id": false,
  "is_show_email": true,
  "is_show_phone": false,
  "status": "ok",
  "s_version": "444085"
}

Field meanings

is_auto_check_in (boolean or null)

Indicates whether automatic check-in during login/search is enabled.

true – auto check-in is enabled.

false – auto check-in is disabled.

null – not configured or using a system default.

is_franchisee_search_wide (boolean)

Controls whether the client search should span multiple franchise locations.

true – search is performed across a wider/franchise-wide scope.

false – search is restricted to the current business/region scope.

is_inactive (boolean)

Indicates whether these login search settings are currently inactive.

true – settings are inactive (may not be applied).

false – settings are active.

is_show_client_id (boolean)

Determines whether the client ID should be visible in the login/search results UI.

true – show the client ID.

false – hide the client ID.

is_show_email (boolean)

Determines whether the client email address is shown in search results.

true – show email.

false – hide email.

is_show_phone (boolean)

Determines whether the client phone number is shown in search results.

true – show phone.

false – hide phone.

status (string)

High-level status of the API call.

For successful requests, typically "ok".

s_version (string)

Internal version or configuration identifier for these settings.

Useful for debugging, auditing, or cache/version tracking.

Notes

This endpoint is read-only; it does not modify any settings.

Use it before login/search operations if you need to adjust UI or behavior based on the current configuration.

Purpose

Method & URL

Query Parameters

Authentication

Successful Response (200 OK)

Field meanings

Notes

Request

Responses

/v1/login/search/settings

Purpose#

Method & URL#

Query Parameters#

Authentication#

Successful Response (200 OK)#

Field meanings#

Notes#

Request

Responses

Purpose

Method & URL

Query Parameters

Authentication

Successful Response (200 OK)

Field meanings

Notes