/v1/location/list

GET /v1/location/list

Retrieve a list of locations for a given business and region.

This endpoint returns a map of locations keyed by k_location, including basic geographic and contact details.

Authentication / Headers

Auth: Inherits authentication from the parent collection/folder.

Required header(s) (typical pattern for this collection):

Authorization: Bearer {{TOKEN}}

Make sure the TOKEN variable is defined in your active environment.

Query Parameters

id_region (required, integer)
Region identifier to filter locations (e.g., 2).

k_business (required, integer/string)
Business key for which locations should be listed (e.g., 49197).

Example request URL:

Successful 200 OK Response (Shape)

A successful response returns JSON with the following structure:

{
  "a_location": {
    "<location_id>": {
      "f_latitude": "string",
      "f_longitude": "string",
      "k_location": "string",
      "s_title": "string",
      "text_address": "string",
      "text_city": "string",
      "text_country": "string",
      "text_region": "string"
    }
  },
  "status": "ok"
}

a_location – Object where each key is a location ID and each value contains location details.

status – Request status; `

GET /v1/location/list#

Authentication / Headers#

Query Parameters#

Successful 200 OK Response (Shape)#

Request

Responses

GET /v1/location/list

Authentication / Headers

Query Parameters

Successful 200 OK Response (Shape)