/v1/lead/info

Retrieves configuration and display metadata for the public lead capture form for a specific business and region.

This endpoint is typically used by client applications (e.g., websites or landing pages) to dynamically build a "Capture Lead" form, including which fields to show, which are required, and the associated styling.

HTTP

Method: GET

Path: /v1/lead/info

Query Parameters

id_region (required, integer)

The internal region identifier. Determines regional settings that may affect the form configuration.

k_business (required, string or integer)

The business key/ID for which the lead capture form configuration should be returned.

Authentication

Expects a valid WellnessLiving UAT API authentication context.

Typically secured via the same auth mechanism used elsewhere in this collection (e.g., header-based token).

Ensure the appropriate authorization header (such as Authorization: Bearer {{TOKEN}} or equivalent) is present at the collection/folder/request level, as configured in this workspace.

Successful Response (200 OK)

A successful response includes (non-exhaustive):

a_field_list: Array of field definitions for the lead form.

Each item contains:

text_field: Display name/label (e.g., "First name", "Last name", "Email", "Cell phone").

k_field: Internal field key.

is_require: Boolean indicating whether the field is required.

id_field_general, id_field_type, and a_data with additional metadata.

a_skin: Object describing UI/skin configuration for the form, including:

Background, fonts, submit button styles, header text, visibility flags (e.g., logo), and other styling data.

can_use_free_purchase: Boolean indicating whether free purchase options are allowed.

url_captcha: URL for captcha integration (if used).

status: Overall status string (e.g., "ok" on success).

s_version: Version identifier for this configuration payload.

__a_message: Internal list of field-related system identifiers.

Usage Notes

Use a_field_list to drive which inputs are rendered, and which are required, on the lead capture UI.

Use a_skin to apply the server-defined styling so the form matches the configured theme.

This endpoint is read-only and does not create or update leads; it only returns configuration/metadata for building the lead capture form.

HTTP

Query Parameters

Authentication

Successful Response (200 OK)

Usage Notes

Request

Responses

/v1/lead/info

HTTP#

Query Parameters#

Authentication#

Successful Response (200 OK)#

Usage Notes#

Request

Responses

HTTP

Query Parameters

Authentication

Successful Response (200 OK)

Usage Notes