/v1/location/view

GET /v1/location/view

Retrieves detailed information about a specific business location, including address, contact details, logo metadata, amenities, operating hours, and various classification attributes.

Authentication

Expects a valid WellnessLiving auth context (e.g., via TOKEN or gateway auth) as configured at the collection or environment level.

This request itself does not override or define authentication; it inherits auth from its parent collection/folder.

Query Parameters

id_region (number, required)

Region identifier used to scope or filter the location context.

Example: 2.

k_business (string/ID, required)

Business key identifying the parent business (tenant).

Example: 49197.

k_location (string/ID, required)

Location key identifying the individual business location to retrieve.

Example: 315968.

i_logo_height (number, optional)

Desired logo height (in pixels) for generated/returned logo URLs.

Example: 100.

i_logo_width (number, optional)

Desired logo width (in pixels) for generated/returned logo URLs.

Example: 220.

Successful Response (200)

The response body contains metadata for the requested location. Key fields include:

status (string)

Overall status of the call; example: "ok".

s_version (string)

Internal version or revision identifier for this location payload.

a_age (array of strings)

Age groups supported or targeted by this location.

a_amenities (array of strings)

Amenity identifiers available at this location.

a_level (array)

Level/classification data for the location (empty in the sample).

a_logo (object)

Logo configuration for the location.

is_empty (boolean): false if a logo is present.

k_business, k_location: IDs associated with the logo.

a_image (object): image metadata and URLs.

i_height, i_width: returned image dimensions.

i_height_src, i_width_src: original image dimensions.

id_type_src: source image type identifier.

is-resize (boolean): indicates whether the image was resized.

url-view: URL for viewing the logo.

url-thumbnail: URL for a thumbnail version of the logo.

i_height, i_width: requested/target dimensions applied to the logo.

s_url: primary logo URL.

a_slide (array)

Slide/image carousel data (empty in the sample).

a_work (object)

Weekly operating hours for the location, keyed by day of week (1–7).

Each key contains an array of intervals with:

s_start: start time (HH:MM:SS).

s_end: end time (HH:MM:SS).

f_latitude, f_longitude (numbers)

Geolocation of the business location.

html_description_full (string)

Full HTML description of the location.

html_description_preview (string)

Short/preview HTML description.

id_industry (number)

Industry identifier for this business.

is_phone (boolean)

Indicates whether a phone number is available.

is_top_choice (boolean)

Flags this location as a "top choice" in UI/marketing contexts.

k_business (string/ID)

Business key associated with this location.

k_business_type (string/ID)

Business type identifier.

k_timezone (string/ID)

Internal timezone key for this location.

Address & Contact

s_address (string)

Street address (e.g., "901 W Washington Blvd").

s_map (string)

Formatted address string for map display.

s_phone (string)

Contact phone number (e.g., "+13128501785").

s_timezone (string)

Timezone string (e.g., "America/Argentina/Salta").

s_title (string)

Location display name (e.g., "Barbie 1").

text_address_individual (string)

Address line used in individual/compact displays.

text_alias (string)

Location alias/slug (e.g., "barbieland").

text_business_type (string)

Human-readable business type (e.g., "Yoga Studio").

text_city (string)

text_country (string)

text_postal (string)

text_region (string)

text_region_code (string)

Industry & Communication

text_industry (string)

Human-readable industry name (e.g., "Affiliate Gym").

text_mail (string)

Primary contact email address.

url_facebook, url_instagram, url_linkedin, url_twitter, url_youtube (strings)

Social media profile URLs (empty in the sample).

url_map (string)

Link to a map view for this location.

url_microsite (string)

Microsite URL for the location.

url_site (string)

Main website URL (may be empty).

url_web (string)

Web scheduling or booking URL.

Miscellaneous

__a_message (array of strings)

Internal or diagnostic message codes related to business policies or configuration.

This endpoint is typically used wherever the application needs to render a single location’s full profile (branding, address, hours, industry metadata, and external links) for the specified business and region.

Authentication

Query Parameters

Successful Response (200)

Address & Contact

Industry & Communication

Miscellaneous

Request

Responses

/v1/location/view

Authentication#

Query Parameters#

Successful Response (200)#

Address & Contact#

Industry & Communication#

URLs & Social Profiles#

Miscellaneous#

Request

Responses

Authentication

Query Parameters

Successful Response (200)

Address & Contact

Industry & Communication

URLs & Social Profiles

Miscellaneous