Skip to content

Lead Details

A method for retrieving detailed information about a lead in Liner by its identifier.

Endpoint and Method

GET /v1/lead/detail/{lead_id}/

lead_id
Lead identifier in Liner. Value must be > 0.

Request Example

curl -X GET "https://YOUR_LINER_API_HOST/v1/lead/detail/{{lead_id}}" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';
$leadId = (int)$lead_id;

$ch = curl_init($host . '/v1/lead/detail/' . $leadId);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_TIMEOUT => 15,
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($response === false) {
    throw new RuntimeException('cURL error: ' . curl_error($ch));
}

curl_close($ch);

echo "HTTP {$httpCode}\n";
echo $response;

const host = "https://YOUR_LINER_API_HOST";
const token = "YOUR_API_TOKEN";
const leadId = Number(lead_id);

const res = await fetch(`${host}/v1/lead/detail/${leadId}`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  }
});

const data = await res.json();
console.log("HTTP", res.status, data);

Response Example

{
  "success": true,
  "message": "",
  "data": {
    "UF_PHONE": "{{UF_PHONE}}",
    "UF_QUIZ_LOG": "{{UF_QUIZ_LOG}}",
    "UF_USER_IP": "{{UF_USER_IP}}",
    "UF_CAMPAIGN_ID": "{{UF_CAMPAIGN_ID}}",
    "UF_ADDITIONAL_PARAMS": "{{UF_ADDITIONAL_PARAMS}}",
    "UF_EXTERNAL_ID": "{{UF_EXTERNAL_ID}}",
    "UF_STATUS": "{{UF_STATUS}}",
    "UF_LEAD_TYPE": "{{UF_LEAD_TYPE}}",
    "UF_CREATE_METHOD": "{{UF_CREATE_METHOD}}",
    "UF_CITY": "{{UF_CITY}}",
    "UF_FAIL_ORDERS": "{{UF_FAIL_ORDERS}}",
    "UF_OBJECTS": "{{UF_OBJECTS}}",
    "UF_IS_SECONDARY": "{{UF_IS_SECONDARY}}",
    "UF_PREVIOUS_LEAD": "{{UF_PREVIOUS_LEAD}}",
    "UF_CALL_DATE_TIME": "{{UF_CALL_DATE_TIME}}",
    "UF_CALL_PRIORITY": "{{UF_CALL_PRIORITY}}",
    "UF_CLIENT_UTC_OFFSET": "{{UF_CLIENT_UTC_OFFSET}}",
    "UF_NEXT_LEAD": "{{UF_NEXT_LEAD}}",
    "UF_PREPARE_IS_FINISHED": "{{UF_PREPARE_IS_FINISHED}}",
    "UF_DATE_CREATE": "{{UF_DATE_CREATE}}",
    "UF_DATE_UPDATE": "{{UF_DATE_UPDATE}}",
    "ID": "{{ID}}",
    "UF_NAME": "{{UF_NAME}}",
    "UF_ORDER": "{{UF_ORDER}}",
    "UF_SELECTION_TYPE": "{{UF_SELECTION_TYPE}}",
    "vkId": "{{vkId}}",
    "instagramLogin": "{{instagramLogin}}",
    "telegramUserName": "{{telegramUserName}}",
    "telegramPhone": "{{telegramPhone}}"
  }
}

Response Fields

Field Type Description
UF_PHONE string Client phone number (typically E.164, e.g. +79001234567).
UF_QUIZ_LOG string Questionnaire comment/log (may be plain text or a JSON string).
UF_USER_IP string User IP address (if collected).
UF_CAMPAIGN_ID string Ad campaign identifier.
UF_ADDITIONAL_PARAMS object string
UF_EXTERNAL_ID string Lead identifier in an external system (CRM/affiliate network, etc.).
UF_STATUS string Current lead status in Liner (status code/value).
UF_LEAD_TYPE string Lead type (e.g. straight / selection).
UF_CREATE_METHOD string Lead creation method (API/form/manual — depends on the system).
UF_CITY string null
UF_FAIL_ORDERS array null
UF_OBJECTS string null
UF_IS_SECONDARY bool null
UF_PREVIOUS_LEAD int null
UF_CALL_DATE_TIME int Date/time of the next call (ISO string/Unix/internal format).
UF_CALL_PRIORITY int Lead priority in the call queue.
UF_CLIENT_UTC_OFFSET int Client time zone offset from UTC (e.g. 3, -5).
UF_NEXT_LEAD int null
UF_PREPARE_IS_FINISHED int “Preparation” completion flag (internal process field).
UF_DATE_CREATE string Lead creation date/time (usually an ISO string or system-specific format).
UF_DATE_UPDATE string Lead last update date/time.
ID int Lead identifier in Liner.
UF_NAME string Client name.
UF_ORDER int Related order (often the order ID; sometimes an object).
UF_SELECTION_TYPE string Selection type.
vkId string VK user identifier.
instagramLogin string Instagram user login.
telegramUserName string Telegram username.
telegramPhone string Telegram phone number (if known).

Note

The structure of the data field is described above. For the overall API response format, see Request Schema