curl --request GET \
--url https://app.flextell.ai/api/v1/leads \
--header 'Authorization: Bearer <token>' \
--header 'X-Tenant: <x-tenant>'import requests
url = "https://app.flextell.ai/api/v1/leads"
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Tenant': '<x-tenant>', Authorization: 'Bearer <token>'}
};
fetch('https://app.flextell.ai/api/v1/leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.flextell.ai/api/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Tenant: <x-tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.flextell.ai/api/v1/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Tenant", "<x-tenant>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.flextell.ai/api/v1/leads")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"description": "<string>",
"message": "<string>",
"preferred_contact": "<string>",
"source_page_url": "<string>",
"avatar_url": "<string>",
"latest_conversation_id": 123,
"expected_value": "<string>",
"currency_id": 123,
"exchange_rate": "<string>",
"country_id": 123,
"is_converted": "<string>",
"converted_at": "2023-11-07T05:31:56Z",
"won_at": "2023-11-07T05:31:56Z",
"lost_reason": "<string>",
"lost_at": "2023-11-07T05:31:56Z",
"lost_by_user_id": 123,
"customer_id": 123,
"marketing_attribution": [
"<unknown>"
],
"external_id": "<string>",
"external_branch_id": "<string>",
"external_created_at": "2023-11-07T05:31:56Z",
"last_synced_at": "2023-11-07T05:31:56Z",
"import_source_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"stage": {
"id": 123,
"name": "<string>",
"color": "<string>",
"is_won": true,
"is_lost": true
},
"reference_source": {
"id": 123,
"name": "<string>",
"external_id": "<string>"
},
"treatments": [
"<string>"
],
"assigned_user": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"country_name": "<string>",
"notification_channels": {
"default_channel_id": "<string>",
"source": "<string>",
"channels": [
"<unknown>"
]
},
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
},
"integration_source": {
"connection_id": 123,
"connection_name": "<string>",
"integration": {
"id": 123,
"name": "<string>",
"system_name": "<string>",
"company_logo": null
},
"external_id": "<string>"
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 2,
"from": 2,
"last_page": 2,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 1,
"to": 2,
"total": 1
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Get all leads
curl --request GET \
--url https://app.flextell.ai/api/v1/leads \
--header 'Authorization: Bearer <token>' \
--header 'X-Tenant: <x-tenant>'import requests
url = "https://app.flextell.ai/api/v1/leads"
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Tenant': '<x-tenant>', Authorization: 'Bearer <token>'}
};
fetch('https://app.flextell.ai/api/v1/leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.flextell.ai/api/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Tenant: <x-tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.flextell.ai/api/v1/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Tenant", "<x-tenant>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.flextell.ai/api/v1/leads")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"record_state": {
"is_read_only": true,
"reason_code": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"description": "<string>",
"message": "<string>",
"preferred_contact": "<string>",
"source_page_url": "<string>",
"avatar_url": "<string>",
"latest_conversation_id": 123,
"expected_value": "<string>",
"currency_id": 123,
"exchange_rate": "<string>",
"country_id": 123,
"is_converted": "<string>",
"converted_at": "2023-11-07T05:31:56Z",
"won_at": "2023-11-07T05:31:56Z",
"lost_reason": "<string>",
"lost_at": "2023-11-07T05:31:56Z",
"lost_by_user_id": 123,
"customer_id": 123,
"marketing_attribution": [
"<unknown>"
],
"external_id": "<string>",
"external_branch_id": "<string>",
"external_created_at": "2023-11-07T05:31:56Z",
"last_synced_at": "2023-11-07T05:31:56Z",
"import_source_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"stage": {
"id": 123,
"name": "<string>",
"color": "<string>",
"is_won": true,
"is_lost": true
},
"reference_source": {
"id": 123,
"name": "<string>",
"external_id": "<string>"
},
"treatments": [
"<string>"
],
"assigned_user": {
"id": 123,
"name": "<string>",
"avatar_url": "<string>"
},
"country_name": "<string>",
"notification_channels": {
"default_channel_id": "<string>",
"source": "<string>",
"channels": [
"<unknown>"
]
},
"import_source": {
"id": 123,
"name": "<string>",
"company_logo": null
},
"integration_source": {
"connection_id": 123,
"connection_name": "<string>",
"integration": {
"id": 123,
"name": "<string>",
"system_name": "<string>",
"company_logo": null
},
"external_id": "<string>"
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 2,
"from": 2,
"last_page": 2,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 1,
"to": 2,
"total": 1
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Yetkilendirmeler
The access token received from the authorization server in the OAuth 2.0 flow.
Başlıklar
Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.
Sorgu Parametreleri
Filter by pipeline stage ID.
Filter by lead reference source ID.
An assigned user ID to filter by.
Filter by converted status (true for converted leads).
Filter by active status: true returns leads that are neither converted nor in a won or
lost stage (the definition the lead cap and the salesperson's active_lead_count use),
false returns the rest.
The search query.
255Filter by creation date (inclusive lower bound).
Filter by creation date (inclusive upper bound).
Filter by conversion date (inclusive lower bound).
Filter by conversion date (inclusive upper bound).
The field to sort by.
created_at, last_name, first_name, converted_at, last_synced_at The sort direction (asc or desc).
asc, desc, null The number of items per page.
1 <= x <= 100The page number.
x >= 1