Authentication and endpoints
Authenticate every request with your organization API key:Visitor payload
The Data API returns the same canonical visitor data fields used by webhook deliveries, inside API-specific list, qualification, and journey response structures.Data API responses are not byte-for-byte copies of webhook payloads. Webhooks include an event envelope with fields such as
event, timestamp, trigger, organizationId, and segment. The Data API uses pagination, filtering, and journey response structures instead.
Canonical arrays are returned as empty arrays when no values are available. Nullable scalar fields are returned as
null.
Email hashes apply to the normalized primary email in email. They are not hashes for every address in emails. emailHash and emailHashes.sha256 both contain the SHA-256 value.
Phone numbers are returned in phones. Phone hashes are not currently generated. phonesDnc is a boolean do-not-call status, or null when the status is unavailable.
Use the generated endpoint pages under Visitors for the complete response schema.
Passing partner-specific data through the pixel
Append custom query parameters to the existing pixel script URL when you need to associate visitors with a partner customer, campaign, or another internal label.& instead of starting another query string with ?.
Leadpipe captures the parameters with the visitor session and returns them in customAttribution:
Query qualified visitors
UsePOST /v1/data/query to eliminate low-fit traffic before it reaches your workflow. The following rule returns visitors who:
- Viewed a pricing page or a URL containing
/book-a-call. - Have director-level seniority or a job title containing
founder.
/book-a-call with the customer’s actual call-booking path, such as /schedule, /contact-sales, or /demo.
The endpoint also accepts a saved segment:
segmentId or ruleAst. A saved segment must belong to the organization associated with the API key. Cross-organization segment IDs return 404.
Qualification queries accept at most 25 predicates with a maximum rule depth of 8.
Pagination and rate limits
Use
meta.hasMore and increment meta.page until meta.hasMore becomes false.
Backward compatibility
Existing Data API aliases remain available, but new integrations should use the canonical names.
Use
phonesDnc instead of phonesDNC. The canonical field is a boolean or null; the legacy field retains its older array-or-null shape.
Use companyEmployeeCount instead of the ambiguous companySize. Both fields contain a numeric employee count for backward compatibility.
Next steps
- Open Query visitor data for the complete list and journey schema.
- Open Query qualified visitor data for the generated qualification endpoint reference.
- Read Manage pixels to install pixels and pass custom attribution.
- Read Visitor suppression to exclude unwanted traffic from credits and automations.