Meta Lead Ads
App · 8 actions
Retrieve Facebook and Instagram lead ad submissions, manage lead forms and create test leads.
Actions
| Action | What it does |
|---|---|
| Create test lead | Create a made-up test lead on a form, to try a workflow without running an ad. |
| Delete test lead | Delete a test lead, so another can be created on its form. |
| Get form | Get one lead form: its name, status, how many leads it has collected and the questions it asks. |
| Get lead | Get one lead by its ID: their name, email, phone and every answer they gave on the form, ready to read, with the form, ad and campaign they came from. |
| Get page | Get the name and ID of the Facebook Page this connection reads leads from. |
| List forms | List the lead forms (Instant Forms) on the connected Facebook Page, with each form's name, ID, status and how many leads it has collected. |
| List leads | List the people who filled in a lead form. |
| List test leads | List the test leads on a form, each with their name, email, phone and every answer ready to read (in leads), the same way List leads does. |
Create test lead
Create a made-up test lead on a form, to try a workflow without running an ad. Meta usually keeps one test lead per form at a time, so delete the old one before creating another.
Inputs
- Form
form_idtextRequired - The lead form. Choose it from the list of the connected Page's forms, or give its ID, a long number such as 1234567890123456. List forms returns every form's ID; in Meta, your forms are listed under Instant Forms, in the All tools menu of Ads Manager or Meta Business Suite.
- Answers
field_datalist - The answers to give the test lead, as a list with one entry per question, such as [{"name": "email", "values": ["ada@example.com"]}]. Each name is a question's key (Get form lists them). Leave blank and Meta fills in sample answers.
Outputs
dataobject- Meta Lead Ads response data.
Example output
{
"data": {
"id": "example"
}
}Delete test lead
Delete a test lead, so another can be created on its form. Leads from real people can't be deleted with this.
Inputs
- Test lead ID
lead_idtextRequired - The test lead's ID, as returned by Create test lead or List test leads.
Outputs
dataobject- Meta Lead Ads response data.
Example output
{
"data": {
"success": false
}
}Get form
Get one lead form: its name, status, how many leads it has collected and the questions it asks. Each question's key is the name its answer is filed under in a lead's answers.
Inputs
- Form
form_idtextRequired - The lead form. Choose it from the list of the connected Page's forms, or give its ID, a long number such as 1234567890123456. List forms returns every form's ID; in Meta, your forms are listed under Instant Forms, in the All tools menu of Ads Manager or Meta Business Suite.
Outputs
dataobject- Meta Lead Ads response data.
Example output
{
"data": {
"created_time": "example",
"id": "example",
"leads_count": 1,
"locale": "example",
"name": "example",
"privacy_policy_url": "example",
"questions": [],
"status": "example"
}
}Get lead
Get one lead by its ID: their name, email, phone and every answer they gave on the form, ready to read, with the form, ad and campaign they came from.
Inputs
- Lead ID
lead_idtextRequired - The lead's ID, a long number such as 1234567890123456. The New lead trigger gives it as lead_id, and List leads gives it for each lead.
Outputs
ad_nametext- Beta. The name of the ad the lead came from. Empty when the lead didn't come from an ad or the connection can't see ad details.
adset_nametext- Beta. The name of the ad set that ad belongs to.
answersobject- Beta. Every answer on the form, by question, so any of them can be read on its own: answers.email, answers.company_name, answers.job_title, answers.city, or a question of your own such as answers.what_is_your_budget. A question is named by its key on the form (Get form lists them), in lower case with _ between words and no punctuation. A question with several answers gives a list.
answers_texttext- Beta. Every answer ready to read, one 'Question: answer' per line, such as 'Full name: Ada Lovelace', ready to paste into a note, a row or a message with no step to join them.
campaign_nametext- Beta. The name of the campaign that ad belongs to.
createdtext- Beta. When the person submitted the form, as a date and time in UTC, such as 2026-11-10T18:02:11+00:00.
created_displaytext- Beta. created written for a person, such as Tue, Nov 10, 2026 at 6:02 PM UTC, ready for a message or a row with no date step.
dataobject- The lead exactly as Meta sends it. Prefer the fields beside data (full_name, email, phone, answers), which hold the same lead ready to read.
emailtext- Beta. The person's email address (their work email if that is the only one the form asked for). Empty when the form didn't ask for one.
first_nametext- Beta. The person's first name, such as Ada, ready for 'Hi Ada,'. Taken from the full name when the form only asked for that.
form_idtext- Beta. The ID of the form they filled in.
full_nametext- Beta. The person's full name, such as Ada Lovelace. Put together from their first and last name when the form asked for those separately. Empty when the form didn't ask for a name.
is_organictrue/false- Beta. True when the lead didn't come from a paid ad, false when it did.
last_nametext- Beta. The person's last name, such as Lovelace. Taken from the full name when the form only asked for that.
lead_idtext- Beta. The lead's ID, a long number. Get lead takes it.
phonetext- Beta. The person's phone number as they gave it, usually with the country code, such as +14155550123, ready for a text message step. Empty when the form didn't ask for one.
platformtext- Beta. Where the form was filled in, as Meta reports it, such as fb for Facebook or ig for Instagram.
Example output
{
"ad_name": "Free quote - video",
"adset_name": "Homeowners 30-55",
"answers": {
"company_name": "Analytical Engines",
"email": "ada@example.com",
"full_name": "Ada Lovelace",
"phone_number": "+14155550123"
},
"answers_text": "Full name: Ada Lovelace\nEmail: ada@example.com\nPhone number: +14155550123\nCompany name: Analytical Engines",
"campaign_name": "Autumn quotes",
"created": "2026-11-10T18:02:11+00:00",
"created_display": "Tue, Nov 10, 2026 at 6:02 PM UTC",
"data": {
"ad_id": "example",
"ad_name": "example",
"adset_id": "example",
"adset_name": "example",
"campaign_id": "example",
"campaign_name": "example",
"created_time": "example",
"field_data": [],
"form_id": "example",
"id": "example",
"is_organic": false,
"platform": "example"
},
"email": "ada@example.com",
"first_name": "Ada",
"form_id": "2345678901234567",
"full_name": "Ada Lovelace",
"is_organic": false,
"last_name": "Lovelace",
"lead_id": "1234567890123456",
"phone": "+14155550123",
"platform": "fb"
}Get page
Get the name and ID of the Facebook Page this connection reads leads from.
Inputs
None.
Outputs
dataobject- Meta Lead Ads response data.
Example output
{
"data": {
"id": "example",
"name": "example"
}
}List forms
List the lead forms (Instant Forms) on the connected Facebook Page, with each form's name, ID, status and how many leads it has collected.
Inputs
- Limit
limitnumber - How many forms to return at once, from 1 to 100. Leave blank for Meta's usual batch size.From 1 to 100.
- After
aftertext - To get the next batch, paste the value found at data.paging.cursors.after in the previous result. Leave blank to start from the beginning.
- Status
statustext - Only list forms in this state: ACTIVE (collecting leads), ARCHIVED or DRAFT. Leave blank to list them all.One of:
ACTIVE,ARCHIVED,DRAFT.
Outputs
dataobject- Meta Lead Ads response data.
Example output
{
"data": {
"data": [],
"paging": {
"cursors": {
"after": "example"
},
"next": "example"
}
}
}List leads
List the people who filled in a lead form. Each one comes with their name, email, phone and every answer ready to read (in leads), so no step is needed to pick them out of Meta's raw data.
Inputs
- Form
form_idtextRequired - The lead form. Choose it from the list of the connected Page's forms, or give its ID, a long number such as 1234567890123456. List forms returns every form's ID; in Meta, your forms are listed under Instant Forms, in the All tools menu of Ads Manager or Meta Business Suite.
- Limit
limitnumber - How many leads to return at once, from 1 to 100. Leave blank for Meta's usual batch size.From 1 to 100.
- After
aftertext - To get the next batch, paste the value found at data.paging.cursors.after in the previous result. Leave blank to start from the beginning.
Outputs
dataobject- Meta Lead Ads response data.
leadslist- Beta. The same leads ready to read, in the same order as data: each with full_name, first_name, last_name, email, phone, answers and answers_text, so no step is needed to pick them out of Meta's data.
Example output
{
"data": {
"data": [],
"paging": {
"cursors": {
"after": "example"
},
"next": "example"
}
},
"leads": [
{
"ad_name": "Free quote - video",
"adset_name": "Homeowners 30-55",
"answers": {
"company_name": "Analytical Engines",
"email": "ada@example.com",
"full_name": "Ada Lovelace",
"phone_number": "+14155550123"
},
"answers_text": "Full name: Ada Lovelace\nEmail: ada@example.com\nPhone number: +14155550123\nCompany name: Analytical Engines",
"campaign_name": "Autumn quotes",
"created": "2026-11-10T18:02:11+00:00",
"created_display": "Tue, Nov 10, 2026 at 6:02 PM UTC",
"email": "ada@example.com",
"first_name": "Ada",
"form_id": "2345678901234567",
"full_name": "Ada Lovelace",
"is_organic": false,
"last_name": "Lovelace",
"lead_id": "1234567890123456",
"phone": "+14155550123",
"platform": "fb"
}
]
}List test leads
List the test leads on a form, each with their name, email, phone and every answer ready to read (in leads), the same way List leads does.
Inputs
- Form
form_idtextRequired - The lead form. Choose it from the list of the connected Page's forms, or give its ID, a long number such as 1234567890123456. List forms returns every form's ID; in Meta, your forms are listed under Instant Forms, in the All tools menu of Ads Manager or Meta Business Suite.
Outputs
dataobject- Meta Lead Ads response data.
leadslist- Beta. The same leads ready to read, in the same order as data: each with full_name, first_name, last_name, email, phone, answers and answers_text, so no step is needed to pick them out of Meta's data.
Example output
{
"data": {
"data": []
},
"leads": [
{
"ad_name": "Free quote - video",
"adset_name": "Homeowners 30-55",
"answers": {
"company_name": "Analytical Engines",
"email": "ada@example.com",
"full_name": "Ada Lovelace",
"phone_number": "+14155550123"
},
"answers_text": "Full name: Ada Lovelace\nEmail: ada@example.com\nPhone number: +14155550123\nCompany name: Analytical Engines",
"campaign_name": "Autumn quotes",
"created": "2026-11-10T18:02:11+00:00",
"created_display": "Tue, Nov 10, 2026 at 6:02 PM UTC",
"email": "ada@example.com",
"first_name": "Ada",
"form_id": "2345678901234567",
"full_name": "Ada Lovelace",
"is_organic": false,
"last_name": "Lovelace",
"lead_id": "1234567890123456",
"phone": "+14155550123",
"platform": "fb"
}
]
}