/v1/user

Retrieves detailed profile information for a single user.

Purpose

Fetches the primary profile record for a user (identified by uid) in a specific region and business.

Returns core identity and contact details, membership identifiers, and selected custom fields.

HTTP

Method: GET

Path: /v1/user

Authentication

Expects an authenticated request using the TOKEN variable (for example via an Authorization header or equivalent mechanism configured at the collection/environment level).

Ensure TOKEN is valid for the given region/business and has permission to read user data.

Required query parameters

id_region (number): Region identifier for the API call (e.g., 2).

k_business (number/string): Business key that scopes the user lookup (e.g., 49197).

uid (string): Unique user identifier within the business (e.g., 2720946).

Main 200 OK response fields
A successful 200 OK response includes (non‑exhaustive):

Top‑level user fields

uid: User’s unique identifier.

s_first_name / s_last_name: User’s first and last name.

s_mail: Primary email address.

s_phone, s_phone_home, s_phone_work: Primary, home, and work phone numbers.

text_address, text_city, text_postal: Mailing address components.

id_gender: Numeric gender identifier.

dt_birth: Date of birth (YYYY-MM-DD).

dt_add: Datetime when the user record was added.

s_member: Membership / account number.

k_city: Internal city key.

k_login_type / text_login_type: Login/membership type identifier and human‑readable label.

has_discount: Whether the user currently has any discount applied (boolean).

is_customer_new: Indicates if the user is considered a new customer (boolean).

is_traveller: Indicates if the user is marked as a traveller (boolean).

url_photo: URL of the user’s profile photo (may be empty).

Custom fields and related data

a_custom_field: Array of custom field objects, each with:

k_field: Custom field key.

text_title: Display label of the custom field.

text_value: Stored value (often an ID or code).

text_value_title: Human‑readable value/choice label when applicable.

a_member_group: Array of membership/group entries (empty in the sample response, but reserved for group/membership data).

a_photo: Object with profile photo metadata:

url_photo: Photo URL.

i_width / i_height: Image dimensions.

Aggregated result map

a_result_list: Object keyed by uid containing a nested copy of the user profile data (same structure as the top‑level user fields and arrays). This can be used when handling multiple users or mapping by uid key.

Meta fields

can_introductory: Whether the user is eligible for introductory offers (boolean).

status: Request status string, e.g., "ok".

s_version: Internal API/version marker for this response.

A 200 OK response with status="ok" indicates the user was successfully found for the provided region, business, and uid.

Request

Responses