curl --request GET \
--url https://octanist.com/api/leads \
--header 'X-API-KEY: <api-key>'import requests
url = "https://octanist.com/api/leads"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://octanist.com/api/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://octanist.com/api/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 => [
"X-API-KEY: <api-key>"
],
]);
$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://octanist.com/api/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://octanist.com/api/leads")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://octanist.com/api/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "lead_abc123",
"externalId": "QUOTE-2026-0042",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"status": "won",
"value": 5000,
"note": "Customer notes",
"custom": "{\"company\":\"Acme Inc\"}",
"lossReason": null,
"conversionName": "Purchase",
"source": "gtm",
"website": "https://example.com",
"path": "/pricing",
"referrer": "https://google.com",
"country": "NL",
"gclid": "abc123",
"dclid": "dclid123",
"wbraid": "wbraid123",
"gbraid": "gbraid123",
"ga4cid": "GA1.1.123456789.1234567890",
"ga4sid": "1234567890",
"fbc": "fb.1.1234567890.abc123",
"fbp": "fb.1.1234567890.987654321",
"msclkid": "msclkid123",
"ttclid": "ttclid123",
"twclid": "twclid123",
"rdt_cid": "rdtcid123",
"sccid": "sccid123",
"epik": "epik123",
"li_fat_id": "lifatid123",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "headline_a",
"utm_term": "brand keyword",
"ad_storage": true,
"ad_user_data": true,
"analytics_storage": true,
"ad_personalization": true,
"googleAdsCampaignId": "123456789",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignName": "Spring Sale 2026",
"googleAdsAdGroupId": "987654321",
"googleAdsAdGroupName": "Brand Keywords",
"googleAdsAdId": "111222333",
"googleAdsDevice": "DESKTOP",
"googleAdsAdNetworkType": "SEARCH",
"googleAdsClickType": "Headline",
"googleAdsSlot": "Search Top",
"labelId": "label_xyz",
"selectedConversionEventId": "conv_123",
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-02-20T14:00:00.000Z",
"qualifiedAt": "2026-01-18T09:00:00.000Z",
"expiresAt": "2026-04-15T10:30:00.000Z",
"session": {
"id": "sess_abc123",
"source": "pixel",
"visitorId": "visitor_abc",
"startedAt": "2026-01-15T10:00:00.000Z",
"lastActivityAt": "2026-01-15T10:28:00.000Z",
"consentAnalytics": true,
"consentMarketing": true,
"consentSource": "granted",
"gclid": "abc123",
"gclsrc": "<string>",
"gclidCapturedAt": "2026-01-15T10:00:05.000Z",
"gclidSource": "url",
"dclid": "<string>",
"wbraid": "<string>",
"gbraid": "<string>",
"fbc": "<string>",
"fbp": "<string>",
"msclkid": "<string>",
"ttclid": "<string>",
"li_fat_id": "<string>",
"twclid": "<string>",
"sccid": "<string>",
"epik": "<string>",
"rdt_cid": "<string>",
"ga4cid": "<string>",
"ga4sid": "<string>",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "<string>",
"utm_term": "<string>",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "<string>",
"googleAdsCampaignName": "<string>",
"googleAdsAdGroupId": "<string>",
"googleAdsAdGroupName": "<string>",
"googleAdsAdId": "<string>",
"googleAdsDevice": "<string>",
"googleAdsAdNetworkType": "<string>",
"googleAdsClickType": "<string>",
"googleAdsSlot": "<string>",
"referrer": "https://google.com",
"domain": "example.com",
"path": "/pricing",
"country": "NL",
"deviceType": "desktop"
},
"sessions": [
{
"id": "sess_abc123",
"source": "pixel",
"visitorId": "visitor_abc",
"startedAt": "2026-01-15T10:00:00.000Z",
"lastActivityAt": "2026-01-15T10:28:00.000Z",
"consentAnalytics": true,
"consentMarketing": true,
"consentSource": "granted",
"gclid": "abc123",
"gclsrc": "<string>",
"gclidCapturedAt": "2026-01-15T10:00:05.000Z",
"gclidSource": "url",
"dclid": "<string>",
"wbraid": "<string>",
"gbraid": "<string>",
"fbc": "<string>",
"fbp": "<string>",
"msclkid": "<string>",
"ttclid": "<string>",
"li_fat_id": "<string>",
"twclid": "<string>",
"sccid": "<string>",
"epik": "<string>",
"rdt_cid": "<string>",
"ga4cid": "<string>",
"ga4sid": "<string>",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "<string>",
"utm_term": "<string>",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "<string>",
"googleAdsCampaignName": "<string>",
"googleAdsAdGroupId": "<string>",
"googleAdsAdGroupName": "<string>",
"googleAdsAdId": "<string>",
"googleAdsDevice": "<string>",
"googleAdsAdNetworkType": "<string>",
"googleAdsClickType": "<string>",
"googleAdsSlot": "<string>",
"referrer": "https://google.com",
"domain": "example.com",
"path": "/pricing",
"country": "NL",
"deviceType": "desktop"
}
]
}
],
"meta": {
"pagination": {
"limit": 50,
"page": 1,
"totalPages": 5,
"total": 234,
"hasMore": true
},
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}Get Leads
Retrieve a paginated list of leads with optional filtering, sorting, and field selection
curl --request GET \
--url https://octanist.com/api/leads \
--header 'X-API-KEY: <api-key>'import requests
url = "https://octanist.com/api/leads"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://octanist.com/api/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://octanist.com/api/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 => [
"X-API-KEY: <api-key>"
],
]);
$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://octanist.com/api/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://octanist.com/api/leads")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://octanist.com/api/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "lead_abc123",
"externalId": "QUOTE-2026-0042",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"status": "won",
"value": 5000,
"note": "Customer notes",
"custom": "{\"company\":\"Acme Inc\"}",
"lossReason": null,
"conversionName": "Purchase",
"source": "gtm",
"website": "https://example.com",
"path": "/pricing",
"referrer": "https://google.com",
"country": "NL",
"gclid": "abc123",
"dclid": "dclid123",
"wbraid": "wbraid123",
"gbraid": "gbraid123",
"ga4cid": "GA1.1.123456789.1234567890",
"ga4sid": "1234567890",
"fbc": "fb.1.1234567890.abc123",
"fbp": "fb.1.1234567890.987654321",
"msclkid": "msclkid123",
"ttclid": "ttclid123",
"twclid": "twclid123",
"rdt_cid": "rdtcid123",
"sccid": "sccid123",
"epik": "epik123",
"li_fat_id": "lifatid123",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "headline_a",
"utm_term": "brand keyword",
"ad_storage": true,
"ad_user_data": true,
"analytics_storage": true,
"ad_personalization": true,
"googleAdsCampaignId": "123456789",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignName": "Spring Sale 2026",
"googleAdsAdGroupId": "987654321",
"googleAdsAdGroupName": "Brand Keywords",
"googleAdsAdId": "111222333",
"googleAdsDevice": "DESKTOP",
"googleAdsAdNetworkType": "SEARCH",
"googleAdsClickType": "Headline",
"googleAdsSlot": "Search Top",
"labelId": "label_xyz",
"selectedConversionEventId": "conv_123",
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-02-20T14:00:00.000Z",
"qualifiedAt": "2026-01-18T09:00:00.000Z",
"expiresAt": "2026-04-15T10:30:00.000Z",
"session": {
"id": "sess_abc123",
"source": "pixel",
"visitorId": "visitor_abc",
"startedAt": "2026-01-15T10:00:00.000Z",
"lastActivityAt": "2026-01-15T10:28:00.000Z",
"consentAnalytics": true,
"consentMarketing": true,
"consentSource": "granted",
"gclid": "abc123",
"gclsrc": "<string>",
"gclidCapturedAt": "2026-01-15T10:00:05.000Z",
"gclidSource": "url",
"dclid": "<string>",
"wbraid": "<string>",
"gbraid": "<string>",
"fbc": "<string>",
"fbp": "<string>",
"msclkid": "<string>",
"ttclid": "<string>",
"li_fat_id": "<string>",
"twclid": "<string>",
"sccid": "<string>",
"epik": "<string>",
"rdt_cid": "<string>",
"ga4cid": "<string>",
"ga4sid": "<string>",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "<string>",
"utm_term": "<string>",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "<string>",
"googleAdsCampaignName": "<string>",
"googleAdsAdGroupId": "<string>",
"googleAdsAdGroupName": "<string>",
"googleAdsAdId": "<string>",
"googleAdsDevice": "<string>",
"googleAdsAdNetworkType": "<string>",
"googleAdsClickType": "<string>",
"googleAdsSlot": "<string>",
"referrer": "https://google.com",
"domain": "example.com",
"path": "/pricing",
"country": "NL",
"deviceType": "desktop"
},
"sessions": [
{
"id": "sess_abc123",
"source": "pixel",
"visitorId": "visitor_abc",
"startedAt": "2026-01-15T10:00:00.000Z",
"lastActivityAt": "2026-01-15T10:28:00.000Z",
"consentAnalytics": true,
"consentMarketing": true,
"consentSource": "granted",
"gclid": "abc123",
"gclsrc": "<string>",
"gclidCapturedAt": "2026-01-15T10:00:05.000Z",
"gclidSource": "url",
"dclid": "<string>",
"wbraid": "<string>",
"gbraid": "<string>",
"fbc": "<string>",
"fbp": "<string>",
"msclkid": "<string>",
"ttclid": "<string>",
"li_fat_id": "<string>",
"twclid": "<string>",
"sccid": "<string>",
"epik": "<string>",
"rdt_cid": "<string>",
"ga4cid": "<string>",
"ga4sid": "<string>",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "<string>",
"utm_term": "<string>",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "<string>",
"googleAdsCampaignName": "<string>",
"googleAdsAdGroupId": "<string>",
"googleAdsAdGroupName": "<string>",
"googleAdsAdId": "<string>",
"googleAdsDevice": "<string>",
"googleAdsAdNetworkType": "<string>",
"googleAdsClickType": "<string>",
"googleAdsSlot": "<string>",
"referrer": "https://google.com",
"domain": "example.com",
"path": "/pricing",
"country": "NL",
"deviceType": "desktop"
}
]
}
],
"meta": {
"pagination": {
"limit": 50,
"page": 1,
"totalPages": 5,
"total": 234,
"hasMore": true
},
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | number | No | 50 | Results per page (1-100) |
page | number | No | 1 | Page number |
sort | string | No | createdAt:desc | Sort field and direction |
search | string | No | - | Search across external ID, name, email, and phone |
fields | string | No | - | Comma-separated fields to return |
Filtering
Filters can be applied using query parameters. All filters are optional. Simple filters (exact match):?status=won
?source=gtm
?externalId=QUOTE-2026-0042
?utm_source=google
?status=won,lost
?createdAt[gte]=2026-01-01
?createdAt[lte]=2026-03-01
?value[gte]=100
?value[lt]=1000
?gclid[exists]=true
?fbc[exists]=false
Filterable Fields
| Field | Description |
|---|---|
externalId | Customer-owned lead identifier (exact match) |
status | Lead status: open, qualified, won, lost |
source | Lead source: inbound, gtm, api, manual, wordpress, import |
labelId | Label ID |
value | Lead value (supports comparison operators) |
website | Website URL |
createdAt | Creation date (supports comparison/exists operators) |
updatedAt | Last update date (supports comparison/exists operators) |
qualifiedAt | Qualification date (supports comparison/exists operators) |
Platform Click IDs
All platform click ID fields support theexists operator.
| Field | Platform |
|---|---|
gclid | Google Ads |
dclid | Google Display Click ID |
wbraid | Google Ads web-to-app click ID |
gbraid | Google Ads app-to-web click ID |
ga4cid | Google Analytics 4 Client ID |
ga4sid | Google Analytics 4 Session ID |
fbc | Meta (Facebook) Click ID |
fbp | Meta (Facebook) Browser ID |
msclkid | Microsoft Ads |
ttclid | TikTok |
twclid | X (Twitter) |
rdt_cid | |
sccid | Snapchat |
epik | |
li_fat_id |
UTM Parameters
| Field | Description |
|---|---|
utm_source | UTM source |
utm_medium | UTM medium |
utm_campaign | UTM campaign |
Filter Operators
| Operator | Example | Description |
|---|---|---|
| (none) | ?status=won | Equals |
[gte] | ?value[gte]=100 | Greater than or equal |
[gt] | ?value[gt]=100 | Greater than |
[lte] | ?value[lte]=1000 | Less than or equal |
[lt] | ?value[lt]=1000 | Less than |
[exists] | ?gclid[exists]=true | Field is not null / is null |
Sorting
Sort by any sortable field with direction:?sort=createdAt:desc
?sort=value:asc
?sort=updatedAt:desc
?sort=value:desc,createdAt:asc
createdAt, updatedAt, qualifiedAt, value, externalId, name, email, status
Field Selection
Request only specific fields to reduce response size:?fields=id,externalId,name,email,status,value
id field is always included. Supported field names are the fields shown in Full Lead Object, including session and sessions.
Legacy Parameters
For backward compatibility, these legacy parameters are still supported:| Legacy | Maps To |
|---|---|
updated_after | updatedAt[gte] |
sort=updated_at:desc | sort=updatedAt:desc |
Example Request
curl -X GET \
-H "X-API-KEY: your_api_key" \
"https://octanist.com/api/leads?status=won&createdAt[gte]=2026-01-01&sort=value:desc&limit=20&fields=id,externalId,name,email,value"
Example Response
{
"success": true,
"data": [
{
"id": "lead_abc123",
"externalId": "QUOTE-2026-0042",
"name": "John Doe",
"email": "john@example.com",
"value": 5000
}
],
"meta": {
"pagination": {
"limit": 20,
"page": 1,
"totalPages": 3,
"total": 45,
"hasMore": true
},
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}
Error Responses
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_FILTER | Unknown or invalid filter field |
| 400 | INVALID_DATE | Invalid date value in a date filter |
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 500 | INTERNAL_ERROR | Server error |
Full Lead Object
When no field selection is applied, leads include all available fields. GET responses also includesession (the converting pixel session, or null) and sessions (the scoped journey, same shape as session). Flattened click IDs, UTMs, consent, website, and path stay on the lead. Org-internal session fields (organizationId, ip, userAgent, octaCid) are omitted.
{
"id": "lead_abc123",
"externalId": "QUOTE-2026-0042",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"status": "won",
"value": 5000,
"note": "Customer notes",
"custom": "{\"company\":\"Acme Inc\"}",
"lossReason": null,
"conversionName": "Purchase",
"source": "gtm",
"website": "https://example.com",
"path": "/pricing",
"referrer": "https://google.com",
"country": "NL",
"gclid": "abc123",
"dclid": "dclid123",
"wbraid": "wbraid123",
"gbraid": "gbraid123",
"ga4cid": "GA1.1.123456789.1234567890",
"ga4sid": "1234567890",
"fbc": "fb.1.1234567890.abc123",
"fbp": "fb.1.1234567890.987654321",
"msclkid": "msclkid123",
"ttclid": "ttclid123",
"twclid": "twclid123",
"rdt_cid": "rdtcid123",
"sccid": "sccid123",
"epik": "epik123",
"li_fat_id": "lifatid123",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "headline_a",
"utm_term": "brand keyword",
"ad_storage": true,
"ad_user_data": true,
"analytics_storage": true,
"ad_personalization": true,
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "123456789",
"googleAdsCampaignName": "Spring Sale 2026",
"googleAdsAdGroupId": "987654321",
"googleAdsAdGroupName": "Brand Keywords",
"googleAdsAdId": "111222333",
"googleAdsDevice": "DESKTOP",
"googleAdsAdNetworkType": "SEARCH",
"googleAdsClickType": "Headline",
"googleAdsSlot": "Search Top",
"labelId": "label_xyz",
"selectedConversionEventId": "conv_123",
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-02-20T14:00:00.000Z",
"qualifiedAt": "2026-01-18T09:00:00.000Z",
"expiresAt": "2026-04-15T10:30:00.000Z",
"session": {
"id": "sess_abc123",
"source": "pixel",
"visitorId": "visitor_abc",
"startedAt": "2026-01-15T10:00:00.000Z",
"lastActivityAt": "2026-01-15T10:28:00.000Z",
"consentAnalytics": true,
"consentMarketing": true,
"consentSource": "granted",
"gclid": "abc123",
"gclsrc": null,
"gclidCapturedAt": "2026-01-15T10:00:05.000Z",
"gclidSource": "url",
"dclid": "dclid123",
"wbraid": "wbraid123",
"gbraid": "gbraid123",
"fbc": "fb.1.1234567890.abc123",
"fbp": "fb.1.1234567890.987654321",
"msclkid": "msclkid123",
"ttclid": "ttclid123",
"li_fat_id": "lifatid123",
"twclid": "twclid123",
"sccid": "sccid123",
"epik": "epik123",
"rdt_cid": "rdtcid123",
"ga4cid": "GA1.1.123456789.1234567890",
"ga4sid": "1234567890",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "headline_a",
"utm_term": "brand keyword",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "123456789",
"googleAdsCampaignName": "Spring Sale 2026",
"googleAdsAdGroupId": "987654321",
"googleAdsAdGroupName": "Brand Keywords",
"googleAdsAdId": "111222333",
"googleAdsDevice": "DESKTOP",
"googleAdsAdNetworkType": "SEARCH",
"googleAdsClickType": "Headline",
"googleAdsSlot": "Search Top",
"referrer": "https://google.com",
"domain": "example.com",
"path": "/pricing",
"country": "NL",
"deviceType": "desktop"
},
"sessions": [
{
"id": "sess_abc123",
"source": "pixel",
"visitorId": "visitor_abc",
"startedAt": "2026-01-15T10:00:00.000Z",
"lastActivityAt": "2026-01-15T10:28:00.000Z",
"consentAnalytics": true,
"consentMarketing": true,
"consentSource": "granted",
"gclid": "abc123",
"gclsrc": null,
"gclidCapturedAt": "2026-01-15T10:00:05.000Z",
"gclidSource": "url",
"dclid": "dclid123",
"wbraid": "wbraid123",
"gbraid": "gbraid123",
"fbc": "fb.1.1234567890.abc123",
"fbp": "fb.1.1234567890.987654321",
"msclkid": "msclkid123",
"ttclid": "ttclid123",
"li_fat_id": "lifatid123",
"twclid": "twclid123",
"sccid": "sccid123",
"epik": "epik123",
"rdt_cid": "rdtcid123",
"ga4cid": "GA1.1.123456789.1234567890",
"ga4sid": "1234567890",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_content": "headline_a",
"utm_term": "brand keyword",
"googleAdsCustomerId": "123-456-7890",
"googleAdsClickDate": "2026-01-15",
"googleAdsCampaignId": "123456789",
"googleAdsCampaignName": "Spring Sale 2026",
"googleAdsAdGroupId": "987654321",
"googleAdsAdGroupName": "Brand Keywords",
"googleAdsAdId": "111222333",
"googleAdsDevice": "DESKTOP",
"googleAdsAdNetworkType": "SEARCH",
"googleAdsClickType": "Headline",
"googleAdsSlot": "Search Top",
"referrer": "https://google.com",
"domain": "example.com",
"path": "/pricing",
"country": "NL",
"deviceType": "desktop"
}
]
}
Session Object
session is null when the lead has no converting pixel session. sessions is an array of the same object for the scoped journey. Flattened attribution on the lead is unchanged.
| Field | Type | Description |
|---|---|---|
id | string | Pixel session ID |
source | string | Session source, for example pixel |
visitorId | string | null | Visitor ID |
startedAt | string | null | Session start (ISO 8601) |
lastActivityAt | string | null | Last activity (ISO 8601) |
consentAnalytics | boolean | null | Analytics consent |
consentMarketing | boolean | null | Marketing consent |
consentSource | string | null | Consent source |
gclid | string | null | Google Ads Click ID |
gclsrc | string | null | Google Ads click source |
gclidCapturedAt | string | null | When gclid was captured (ISO 8601) |
gclidSource | string | null | How gclid was captured |
dclid | string | null | Google Display Click ID |
wbraid | string | null | Google Ads web-to-app click ID |
gbraid | string | null | Google Ads app-to-web click ID |
fbc | string | null | Meta (Facebook) Click ID |
fbp | string | null | Meta (Facebook) Browser ID |
msclkid | string | null | Microsoft Ads Click ID |
ttclid | string | null | TikTok Click ID |
li_fat_id | string | null | LinkedIn Click ID |
twclid | string | null | X (Twitter) Click ID |
sccid | string | null | Snapchat Click ID |
epik | string | null | Pinterest click ID |
rdt_cid | string | null | Reddit Click ID |
ga4cid | string | null | Google Analytics 4 Client ID |
ga4sid | string | null | Google Analytics 4 Session ID |
utm_source | string | null | UTM source |
utm_medium | string | null | UTM medium |
utm_campaign | string | null | UTM campaign |
utm_content | string | null | UTM content |
utm_term | string | null | UTM term |
googleAdsCustomerId | string | null | Google Ads customer ID |
googleAdsClickDate | string | null | Google Ads click date (YYYY-MM-DD) |
googleAdsCampaignId | string | null | Google Ads campaign ID |
googleAdsCampaignName | string | null | Google Ads campaign name |
googleAdsAdGroupId | string | null | Google Ads ad group ID |
googleAdsAdGroupName | string | null | Google Ads ad group name |
googleAdsAdId | string | null | Google Ads ad ID |
googleAdsDevice | string | null | Google Ads device |
googleAdsAdNetworkType | string | null | Google Ads network type |
googleAdsClickType | string | null | Google Ads click type |
googleAdsSlot | string | null | Google Ads slot |
referrer | string | null | Referring URL |
domain | string | null | Website domain |
path | string | null | Page path |
country | string | null | Detected country code |
deviceType | string | null | Device type, for example desktop |
Authorizations
API key for authentication
Query Parameters
Results per page (1-100)
1 <= x <= 100Page number
x >= 1Sort field and direction (e.g. createdAt:desc, value:asc). Multiple fields can be combined with commas.
"createdAt:desc"
Search across external ID, name, email, and phone
Comma-separated fields to return. The id field is always included. Use session and sessions to include pixel session objects.
"id,externalId,name,email,status,value"
Filter by lead status. Multiple values can be comma-separated.
"won"
Filter by an exact customer-owned external lead ID
255"QUOTE-2026-0042"
Filter by lead source
inbound, gtm, api, manual, wordpress, import Filter by label ID
Filter by website URL
Filter by UTM source
Filter by UTM medium
Filter by UTM campaign
Legacy parameter. Maps to updatedAt[gte].