List every lead — forms, ad lead forms and ad-opened conversations — in one list
GET/api/leads/unified
The Leads page (doc 105 §4.7): website and ConnectWiz form submissions, ad-platform
lead forms (Meta, Google, LinkedIn, TikTok) and the conversations an ad click or the
site's WhatsApp link opened, newest first, with the same lead definition as the
conversion report — but every lead record is a row by default (per_person=false;
pass per_person=true for the report's one-per-person counting). Each row carries
links to the record (the submission, the inbox thread, the ad lead) and the person.
Needs contacts.manage (the Leads page's permission) and the lead_ads feature.
Form leads need forms.view or forms.manage and the forms feature: with forms.view
alone, only the form leads that have a person (one without needs forms.manage); conversation
leads only for a member who may list conversations, and only the threads their inbox
shows. meta.lead_types says which kinds this caller sees. The won value is null
without conversion_reports.view (and the conversion_reports feature);
meta.value_visible says which.
Request
Responses
- 200
- 401
- 403
- 404
- 422
A page of leads.
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
Authenticated but not allowed.
The lead_ads feature is off for this workspace.
The request failed validation.