TOOL API

lead_get

Retrieves a single lead generated either from an Instant Form or from direct messages of the associated Business Account. Request requirements depend on where the lead is stored: provide `page_id` when `lead_source` is `INSTANT_FORM`, and do not send `page_id` when `lead_source` is `DIRECT_MESSAGE`. If the lead is under a Business Center form library, use `library_id`; to obtain valid library IDs, call `/page/library/get/`. To obtain valid Instant Form page IDs, call `/page/get/` with `business_type=LEAD_GEN`.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.lead_get
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

advertiser_id

Advertiser ID. Required when the lead is under an ad account.

lead_sourcerequired

Source of the lead. `INSTANT_FORM` means the lead was generated through an Instant Form and requires `page_id`. `DIRECT_MESSAGE` means the lead was generated from direct messages of the associated Business Account and does not support `page_id`.

library_id

ID of a form library. Required when the lead is under a form library of a Business Center. To obtain valid library IDs, use `/page/library/get/`.

page_id

Page ID of an Instant Form. Required when `lead_source` is `INSTANT_FORM`. Not supported when `lead_source` is `DIRECT_MESSAGE`. To obtain valid Instant Form page IDs, use `/page/get/` and set `business_type` to `LEAD_GEN`.