### LoginUser Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This is an example of a request body to log in a user and verify API credentials. Ensure you replace YOUR_API_UID and YOUR_API_KEY with your actual credentials. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "LoginUser" } ``` -------------------------------- ### FetchAllTags Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi An example request body to fetch all tags associated with the authenticated account. This call confirms access to tag data after successful authentication. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllTags" } ``` -------------------------------- ### FetchCallTranscripts Request with Pagination Example Source: https://app.hotprospector.com/glu/setting/CustomApi This example demonstrates a request to FetchCallTranscripts, including parameters for pagination like 'limit' and 'cursor'. These parameters are specific to certain endpoints. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchCallTranscripts", "limit": 50, "cursor": 0 } ``` -------------------------------- ### Fetch Lead Fields Name Python Example Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch lead field names using Python with the requests library. The payload is sent as JSON. ```python import requests payload = { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchLeadFieldsName" } response = requests.post("https://app.hotprospector.com/glu/custom_api", json=payload, timeout=30) print(response.json()) ``` -------------------------------- ### Fetch Lead Fields Name cURL Example Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch lead field names using cURL. Ensure the Content-Type header is set to application/json. ```curl curl -X POST https://app.hotprospector.com/glu/custom_api \ -H "Content-Type: application/json" \ -d '{ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchLeadFieldsName" }' ``` -------------------------------- ### Fetch Lead Fields Name Node.js Example Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch lead field names using Node.js with the fetch API. The request body should be a JSON string. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchLeadFieldsName" }) }); console.log(await response.json()); ``` -------------------------------- ### Fetch Member Credits via Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to fetch member credits using the fetch API. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_API_KEY", "Method": "fetchCreditCount" }) }); console.log(await response.json()); ``` -------------------------------- ### Get Member Users using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example uses the fetch API to make a POST request to the custom API for retrieving member users. It includes JSON stringification for the request body. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "getMemberUsers" }) }); console.log(await response.json()); ``` -------------------------------- ### Fetch All Campaigns via Custom API (Python) Source: https://app.hotprospector.com/glu/setting/CustomApi Python example for fetching all campaigns using the requests library. The payload includes the 'FetchAllCampaigns' method. ```python import requests payload = { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllCampaigns" } response = requests.post("https://app.hotprospector.com/glu/custom_api", json=payload, timeout=30) print(response.json()) ``` -------------------------------- ### Fetch Lead Notes using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to fetch lead notes using the Fetch API. It sends a POST request with JSON payload. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "leadId": 12345, "Method": "FetchLeadNotes" }) }); console.log(await response.json()); ``` -------------------------------- ### Add Member User Node.js Example Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js snippet shows how to add a member user using the fetch API. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "addMemberUser", "first_name": "Support", "last_name": "team", "email": "abcxyz@gmail.com", "inbound_phone": "14087777111", "password": "a-sasdasdsA3" }) }); console.log(await response.json()); ``` -------------------------------- ### Add Member User Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object demonstrates the required parameters for adding a new member user via the API. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "addMemberUser", "first_name": "Support", "last_name": "team", "email": "abcxyz@gmail.com", "inbound_phone": "14087777111", "password": "a-sasdasdsA3" } ``` -------------------------------- ### Search Lead by Custom Field (Node.js) Source: https://app.hotprospector.com/glu/setting/CustomApi Node.js example for searching leads by custom fields. Ensure you handle the response JSON. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "GroupId": "1", "searchField": "custom_field", "searchText": "custom_field_value", "sortBy": "ASC", "Method": "SearchByCustomField" }) }); console.log(await response.json()); ``` -------------------------------- ### Get Member Dashboard Data Source: https://app.hotprospector.com/glu/setting/CustomApi This example shows how to retrieve today's aggregated performance metrics for team members using the `getMemberDashboardData` method. You can optionally provide a date to fetch historical data. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "getMemberDashboardData" } ``` -------------------------------- ### Fetch All Campaigns via Custom API (Node.js) Source: https://app.hotprospector.com/glu/setting/CustomApi Node.js example for fetching all campaigns. This uses the fetch API to send a POST request with the 'FetchAllCampaigns' method. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllCampaigns" }) }); console.log(await response.json()); ``` -------------------------------- ### Fetch User SMS Logs Success Response Example Source: https://app.hotprospector.com/glu/setting/CustomApi This is an example of a successful response when fetching user SMS logs. It contains an array of SMS log results, pagination information, and a summary message. ```json [ { "response": "true", "Results": [ { "leadId": "10000001", "lead_Name": "John Doe", "from_number": "+15550000001", "to_number": "+15550000002", "message": "Hi, just following up on your inquiry.", "dated": "Apr 15, 2026 10:30 am", "status": "Sent", "direction": "outbound", "groupId": "236", "tags": "12,45", "messageId": "900001" }, { "leadId": "10000002", "lead_Name": "Jane Smith", "from_number": "+15550000003", "to_number": "+15550000004", "message": "Thank you for reaching out!", "dated": "Apr 15, 2026 11:45 am", "status": "Received", "direction": "inbound", "groupId": "236", "tags": "", "messageId": "900002" } ], "total_records": 1520, "returned_records": 2, "limit": 2, "offset": 0, "has_more": true, "next_offset": 2, "message": "There are 1520 SMS" } ] ``` -------------------------------- ### Add Member User PHP Example Source: https://app.hotprospector.com/glu/setting/CustomApi This PHP code demonstrates how to add a member user using cURL. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "addMemberUser", "first_name" => "Support", "last_name" => "team", "email" => "abcxyz@gmail.com", "inbound_phone" => "14087777111", "password" => "a-sasdasdsA3", ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Fetch Lead Fields Name PHP Example Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch lead field names using PHP with cURL. The payload is encoded as JSON and sent in the request body. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "FetchLeadFieldsName" ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Update Lead Error Response Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object illustrates an error response when a lead is not found. ```json { "response": "false", "message": "No record found for provided leadId: $leadId " } ``` -------------------------------- ### Move Lead using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to move a lead using the Custom API. It utilizes the fetch API for making the POST request. Replace placeholders with your credentials. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "moveGroupId": "5465", "LeadId": "5964", "Method": "MoveLead" }) }); console.log(await response.json()); ``` -------------------------------- ### FetchCallTranscripts API Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This is an example JSON payload for the FetchCallTranscripts API. It demonstrates how to specify various filters such as date range, call type, campaign ID, duration, and sorting preferences. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "return_format": "array", "from_date": "2026-05-01", "to_date": "2026-05-07", "call_type": "inbound", "campaignId": "12345", "groupId": "236", "memberId": "", "statusId": "", "min_duration": 30, "max_duration": 100, "search_phone": "", "search_keyword": "", "flagged_only": false, "recordingId": "", "limit": 100, "offset": 0, "cursor": 0, "sort_by": "call_time", "sort_order": "DESC", "summary_only": false, "compress_transcripts": false, "fields": "", "Method": "FetchCallTranscripts" } ``` -------------------------------- ### Add Member User Python Example Source: https://app.hotprospector.com/glu/setting/CustomApi This Python script uses the requests library to add a new member user. ```python import requests payload = { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "addMemberUser", "first_name": "Support", "last_name": "team", "email": "abcxyz@gmail.com", "inbound_phone": "14087777111", "password": "a-sasdasdsA3" } response = requests.post("https://app.hotprospector.com/glu/custom_api", json=payload, timeout=30) print(response.json()) ``` -------------------------------- ### Add Member User cURL Example Source: https://app.hotprospector.com/glu/setting/CustomApi Use this cURL command to send a POST request to add a new member user. ```curl curl -X POST https://app.hotprospector.com/glu/custom_api \ -H "Content-Type: application/json" \ -d '{ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "addMemberUser", "first_name": "Support", "last_name": "team", "email": "abcxyz@gmail.com", "inbound_phone": "14087777111", "password": "a-sasdasdsA3" }' ``` -------------------------------- ### Move Lead Success Response Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object shows a successful response after moving a lead to a new group. ```json { "response": "true", "LeadId": "5964", "moveGroupId": "5754", "message": "Lead moved Successfully" } ``` -------------------------------- ### Fetch All Groups using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to fetch all groups using the Fetch API. It sends a POST request with JSON payload containing authentication details and the method. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllGroups" }) }); console.log(await response.json()); ``` -------------------------------- ### Update Lead Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object represents a sample request to update an existing lead's first name. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "LeadField": "first_name", "LeadData": "Support", "LeadId": "5976", "Method": "UpdateExistingLead" } ``` -------------------------------- ### Fetch All Tags API cURL Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to make a POST request to the FetchAllTags endpoint using cURL. ```curl curl -X POST https://app.hotprospector.com/glu/custom_api \ -H "Content-Type: application/json" \ -d '{ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllTags" }' ``` -------------------------------- ### FetchAllTags Success Response Example Source: https://app.hotprospector.com/glu/setting/CustomApi This is a sample response from the FetchAllTags endpoint, showing a successful retrieval of tags. Each tag includes its ID, title, and status. ```json [ { "response": "true", "message": "All Tags fetched successfully", "tags": [ { "TagId": "401074", "TagTitle": "new fb lead", "TagStatus": "Active" } ] } ] ``` -------------------------------- ### Add Lead Tags using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example shows how to add tags to a lead using the Fetch API. The 'tagId' parameter accepts a comma-separated string of tag IDs. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "leadId": 12345, "tagId": "5,12,18", "Method": "AddLeadTags" }) }); console.log(await response.json()); ``` -------------------------------- ### Move Lead Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object represents a sample request to move a lead to a different group. Note that this action removes all previous group assignments. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "moveGroupId": "5465", "LeadId": "5964", "Method": "MoveLead" } ``` -------------------------------- ### Fetch All Campaigns via Custom API (PHP) Source: https://app.hotprospector.com/glu/setting/CustomApi PHP example for fetching all campaigns using cURL. The payload is encoded as JSON and includes the 'FetchAllCampaigns' method. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "FetchAllCampaigns" ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Fetch All Tags API Python Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch all tags using the FetchAllTags method in Python with the requests library. ```python import requests payload = { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllTags" } response = requests.post("https://app.hotprospector.com/glu/custom_api", json=payload, timeout=30) print(response.json()) ``` -------------------------------- ### Fetch All Tags API Node.js Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch all tags using the FetchAllTags method in Node.js with the fetch API. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchAllTags" }) }); console.log(await response.json()); ``` -------------------------------- ### Invalid API Credentials Error Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON structure illustrates the response when invalid API credentials (api_uId or api_key) are provided. This error is fatal until credentials are corrected. ```json { "response": "false", "message": "Invalid (api_uId or api_key)" } ``` -------------------------------- ### Deduct Member Credits via Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to deduct member credits using the fetch API. An optional description can be provided. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "creditDeduct", "description": "Some description..." }) }); console.log(await response.json()); ``` -------------------------------- ### Fetch User SMS Logs Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object represents a sample request payload for the FetchUserSMSLogs method. It includes authentication details and filtering parameters for SMS logs. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "FetchUserSMSLogs", "from_date": "2026-05-01", "to_date": "2026-05-07", "direction": "outbound", "groupId": "236", "leadId": "", "status": "", "limit": 100, "offset": 0 } ``` -------------------------------- ### Search Leads by User Input (Node.js) Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to perform a POST request to search for leads using user input. It utilizes the fetch API to send JSON data and log the response. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "GroupId": "1", "searchField": "first_name", "searchText": "Test", "locationId": "loc_1234567890xyz", "sortBy": "ASC", "Method": "SearchByUserInput" }) }); console.log(await response.json()); ``` -------------------------------- ### Get Member Dashboard Data (PHP) Source: https://app.hotprospector.com/glu/setting/CustomApi Use PHP with cURL to get member dashboard data. This example sets up the POST request with JSON payload and returns the response. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "getMemberDashboardData" ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Get Member Dashboard Data (Node.js) Source: https://app.hotprospector.com/glu/setting/CustomApi Fetch general member dashboard data using Node.js with the fetch API. This example demonstrates making a POST request and handling the JSON response. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "getMemberDashboardData" }) }); console.log(await response.json()); ``` -------------------------------- ### Add Multiple Leads via Node.js Fetch API Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to use the fetch API to send a POST request for adding multiple leads. It includes JSON stringification of the payload and logs the response. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "groupId": "5656", "tagId" : [1234,123], "leads_array": [ { "first_name": "Support", "last_name": "Team1", "email": "support1@xyz.com", "phone": "3465656111", "mobile": "3465656111", "country_code": "+1", "website": "http://www.leaddomain.com", "company": "Courtyard by Marriott New York", "zip": "35000", "address": "152 W 10th St New York NY", "title": "test", "Sample Custom Field": "Sample Value" }, { "first_name": "Support", "last_name": "Team2", "email": "support1@xyz.com", "phone": "3465656222", "mobile": "3465656222", "country_code": "+1", "website": "http://www.leaddomain.com", "company": "Courtyard by Marriott New York", "zip": "35000", "address": "152 W 10th St New York NY", "title": "test", "Sample Custom Field": "Sample Value" } ], "Method": "AddMultipleLeads" RESPONSE Copy { "response": "true", "message": "Add leads request has been successfully submitted to the queue and will be processed shortly" } }) }); console.log(await response.json()); ``` -------------------------------- ### Get Member Users using PHP Source: https://app.hotprospector.com/glu/setting/CustomApi This PHP code snippet demonstrates how to make a POST request to the custom API using cURL to get member users. It configures cURL options for the request. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "getMemberUsers" ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Login User API PHP Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to authenticate using the LoginUser method in PHP using cURL. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "LoginUser" ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Fetch Call Transcripts using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to make a POST request to the custom API to retrieve call transcripts. It uses the `fetch` API and requires your API credentials and specific parameters. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "return_format": "array", "from_date": "2026-05-01", "to_date": "2026-05-07", "call_type": "inbound", "campaignId": "12345", "groupId": "236", "memberId": "", "statusId": "", "min_duration": 30, "max_duration": 100, "search_phone": "", "search_keyword": "", "flagged_only": false, "recordingId": "", "limit": 100, "offset": 0, "cursor": 0, "sort_by": "call_time", "sort_order": "DESC", "summary_only": false, "compress_transcripts": false, "fields": "", "Method": "FetchCallTranscripts" }) }); console.log(await response.json()); ``` -------------------------------- ### Login User API Python Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to authenticate using the LoginUser method in Python with the requests library. ```python import requests payload = { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "LoginUser" } response = requests.post("https://app.hotprospector.com/glu/custom_api", json=payload, timeout=30) print(response.json()) ``` -------------------------------- ### Copy Lead to Group using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example shows how to copy a lead to a group using the Custom API. It uses the fetch API for the POST request. Ensure your API details are correctly substituted. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "copyGroupId": "5787", "LeadId": "5964", "Method": "CopyLead" }) }); console.log(await response.json()); ``` -------------------------------- ### Login User API Node.js Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to authenticate using the LoginUser method in Node.js with the fetch API. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "LoginUser" }) }); console.log(await response.json()); ``` -------------------------------- ### Login User API cURL Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to make a POST request to the LoginUser endpoint using cURL. ```curl curl -X POST https://app.hotprospector.com/glu/custom_api \ -H "Content-Type: application/json" \ -d '{ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "LoginUser" }' ``` -------------------------------- ### Fetch Lead SMS Logs using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example shows how to make a POST request to the API using the `fetch` API to retrieve lead SMS logs. It constructs the JSON payload and sends it with the appropriate headers. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "LeadId": "5964", "LeadPhone": "**********", "LeadEmail": "xyz@xyx.com", "from_date": "2024-05-01", "to_date": "2024-12-31", "Method": "FetchLeadSMSLogs" }) }); console.log(await response.json()); ``` -------------------------------- ### Add Multiple Leads to Group Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object demonstrates the structure for adding multiple leads to a group. It includes group ID, an array of lead objects, and the 'AddMultipleLeads' method. Each lead requires at least an email, phone, or mobile number. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "groupId": "5656", "tagId" : [1234,123], "leads_array": [ { "first_name": "Support", "last_name": "Team1", "email": "support1@xyz.com", "phone": "3465656111", "mobile": "3465656111", "country_code": "+1", "website": "http://www.leaddomain.com", "company": "Courtyard by Marriott New York", "zip": "35000", "address": "152 W 10th St New York NY", "title": "test", "Sample Custom Field": "Sample Value" }, { "first_name": "Support", "last_name": "Team2", "email": "support1@xyz.com", "phone": "3465656222", "mobile": "3465656222", "country_code": "+1", "website": "http://www.leaddomain.com", "company": "Courtyard by Marriott New York", "zip": "35000", "address": "152 W 10th St New York NY", "title": "test", "Sample Custom Field": "Sample Value" } ], "Method": "AddMultipleLeads" ``` -------------------------------- ### Add Single Lead using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example demonstrates how to add a single lead using the fetch API. It sends a JSON payload with lead details to the Custom API endpoint. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "groupId": "5787", "tagId": [ 1234, 123 ], "first_name": "Support", "last_name": "Team", "email": "support@xyz.com", "phone": "3465656235", "mobile": "3465656235", "country_code": "+1", "website": "http://www.leadomain.com", "company": "Courtyard by Marriott", "zip": "35000", "address": "152 W 10th St New York NY", "Sample Custom Field": "Sample Value", "title": "test", "Method": "AddSingleLead" }) }); console.log(await response.json()); ``` -------------------------------- ### Move Lead Error Response Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object illustrates an error response when the destination group ID is not found. ```json { "response": "false", "message": "No Records Found for provided moveGroupId $moveGroupId" } ``` -------------------------------- ### Search Leads by User Input (Python) Source: https://app.hotprospector.com/glu/setting/CustomApi This Python script uses the requests library to send a POST request for searching leads by user input. It includes a timeout for the request and prints the JSON response. ```python import requests payload = { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "GroupId": "1", "searchField": "first_name", "searchText": "Test", "locationId": "loc_1234567890xyz", "sortBy": "ASC", "Method": "SearchByUserInput" } response = requests.post("https://app.hotprospector.com/glu/custom_api", json=payload, timeout=30) print(response.json()) ``` -------------------------------- ### Fetch Lead SMS Logs Request Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object demonstrates the structure for requesting SMS logs for a specific lead. Ensure at least one lead identifier (ID, Phone, or Email) is provided along with authentication credentials and the 'FetchLeadSMSLogs' method. ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "LeadId": "5964", "LeadPhone": "**********", "LeadEmail": "xyz@xyx.com", "from_date": "2024-05-01", "to_date": "2024-12-31", "Method": "FetchLeadSMSLogs" } ``` -------------------------------- ### Update Lead Success Response Example Source: https://app.hotprospector.com/glu/setting/CustomApi This JSON object shows a successful response after updating a lead's field. ```json { "response": "true", "LeadId": "5976", "UserField": "first_name", "UserData": "Support", "message": "Lead Field Updated Successfully" } ``` -------------------------------- ### Fetch All Tags API PHP Request Source: https://app.hotprospector.com/glu/setting/CustomApi Example of how to fetch all tags using the FetchAllTags method in PHP using cURL. ```php "YOUR_API_UID", "api_key" => "YOUR_API_KEY", "Method" => "FetchAllTags" ]; $ch = curl_init("https://app.hotprospector.com/glu/custom_api"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($payload), CURLOPT_RETURNTRANSFER => true, ]); echo curl_exec($ch); curl_close($ch); ?> ``` -------------------------------- ### Check Member Limit using Node.js Source: https://app.hotprospector.com/glu/setting/CustomApi This Node.js example shows how to check the member limit by making a POST request to the custom API using the fetch API. It sends the required authentication and method parameters. ```javascript const response = await fetch("https://app.hotprospector.com/glu/custom_api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "checkMemberLimit" }) }); console.log(await response.json()); ``` -------------------------------- ### Get Member Users Source: https://app.hotprospector.com/glu/setting/CustomApi Retrieves a list of all member users associated with your account. Includes details such as name, email, and status. ```APIDOC ## POST /glu/custom_api ### Description Retrieves a list of all member users associated with your account. Includes details such as name, email, and status. ### Method POST ### Endpoint https://app.hotprospector.com/glu/custom_api ### Parameters #### Request Body - **api_uId** (integer) - Required - Your account user ID - **api_key** (string) - Required - Your account API key - **Method** (string) - Required - Must be set to getMemberUsers ### Request Example ```json { "api_uId": "YOUR_API_UID", "api_key": "YOUR_API_KEY", "Method": "getMemberUsers" } ``` ### Response #### Success Response (200) - **response** (string) - Indicates success or failure of the operation. - **data** (array) - An array of member user objects, each containing detailed information. - **memberId** (string) - The unique identifier for the member. - **first_name** (string) - The first name of the member. - **last_name** (string) - The last name of the member. - **email** (string) - The email address of the member. - **title** (string) - The job title of the member. - **company** (string) - The company the member is associated with. - **country** (string) - The country of the member. - **state** (string) - The state of the member. - **city** (string) - The city of the member. - **zip** (string) - The zip code of the member. - **street_address** (string) - The street address of the member. - **industry** (string) - The industry the member works in. - **main_time_zone** (string) - The main time zone of the member. - **sub_time_zone** (string) - The sub time zone of the member. - **inbound_phone** (string) - The inbound phone number. - **direct_number** (string) - The direct phone number. - **direct_call_recording** (string) - Indicates if direct call recording is enabled. - **outbound_call_recording** (string) - Indicates if outbound call recording is enabled. - **outbound_phone** (string) - The outbound phone number. - **inbound_call_option** (string) - The inbound call option selected. - **inbound_call_option_label** (string) - The label for the inbound call option. - **phone_extension** (string) - The phone extension. - **member_status** (string) - The current status of the member. - **dated** (string) - The date and time the record was created or updated. #### Response Example ```json { "response": "true", "data": [ { "memberId": "3232", "first_name": "Support", "last_name": "Team", "email": "abc@hotmail.com", "title": "", "company": "", "country": "USA", "state": "", "city": "", "zip": "", "street_address": "", "industry": "", "main_time_zone": "America", "sub_time_zone": "America/Chicago", "inbound_phone": "", "direct_number": "+12345678900", "direct_call_recording": "false", "outbound_call_recording": "No", "outbound_phone": "", "inbound_call_option": "1", "inbound_call_option_label": "Ring Browser", "phone_extension": "", "member_status": "Active", "dated": "2025-01-21 15:28:07" } ] } ``` ### Error Response ```json { "response": "false", "message": "Invalid (api_uId or api_key)" } ``` ``` -------------------------------- ### Search Leads by User Input (cURL) Source: https://app.hotprospector.com/glu/setting/CustomApi Use this cURL command to send a POST request to search for leads based on user-provided input. Ensure you replace placeholders with your actual API credentials and search parameters. ```bash curl -X POST https://app.hotprospector.com/glu/custom_api \ -H "Content-Type: application/json" \ -d '{ \ "api_uId": "YOUR_API_UID", \ "api_key": "YOUR_API_KEY", \ "GroupId": "1", \ "searchField": "first_name", \ "searchText": "Test", \ "locationId": "loc_1234567890xyz", \ "sortBy": "ASC", \ "Method": "SearchByUserInput" \ }' ```