Zernio
APIFor you
Zernio
APIFor you
API Reference

Lead Gen

List leads for a single formGETList lead formsGETList submitted leadsGETCreate a lead formPOSTCreate a test leadPOSTGet a lead formGETUpdate a lead's statusPATCHDelete a test leadDELETEArchive a lead formDELETE
Dashboard
OverviewPlatformsAPI ReferenceResources
Lead Gen

List leads for a single form

Lists the leads submitted through one Meta lead form.

Serves persisted leads (ingested via the leadgen webhook) when available, falling back to a live Graph read. Accepts a Facebook account or a metaads business-login account with leads_retrieval access to the form; the latter uses its system-user token without a posting parent.

Persisted leads arrive in real time through Meta's webhook, and a background pass re-reads every Page from Meta to catch the leads the webhook misses: every 15 minutes for Pages that received a lead in the last 7 days. meta.lastCheckedAt says when that pass last ran, so polling this endpoint faster than that returns nothing new; subscribe to the lead.received webhook instead. The live Graph read is cached for 5 minutes, and meta.lastCheckedAt is when it was read.


PlatformsMeta
GET
/v1/ads/lead-forms/{formId}/leads

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

formId*string

Query Parameters

accountId*string
limit?integer
Range1 <= value <= 100
Default25
cursor?string
since?integer

Unix seconds.

Response Body

application/json

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.leadgen.listFormLeads({  path: {    formId: 'form_abc123',  },  query: {    accountId: 'account_abc123',  },});console.log(data);
{  "status": "string",  "leads": [    {      "id": "string",      "leadId": "string",      "status": "string",      "createdTime": "string",      "adId": "string",      "formId": "string",      "fields": {        "property1": "string",        "property2": "string"      },      "fieldData": [        {}      ]    }  ],  "pagination": {    "hasMore": true,    "cursor": "string"  },  "meta": {    "platform": "string",    "accountId": "string",    "formId": "string",    "source": "persisted",    "lastCheckedAt": "2019-08-24T14:15:22Z",    "lastUpdated": "2019-08-24T14:15:22Z"  }}
Was this page helpful?

Reserve reach-frequency inventory

Locks the quoted price and inventory of a Meta reach and frequency prediction so you can launch a campaign on it. Locks the quoted price + inventory until the returned `expiresAt` and mints a NEW prediction id. Pass that RESERVED id (not the original) as `rfPredictionId` on POST /v1/ads/create. Release an unused reservation via DELETE.

List lead forms

Lists the lead forms on a Facebook Page or LinkedIn Company Page. Meta: forms on the connected Facebook Page. Pass either the `metaads` ads connection (the Page is taken from the Facebook account linked to it) or the Facebook account itself. LinkedIn: forms owned by the ad account's Company Page. Pass `adAccountId` (LinkedIn forms are org-owned). Requires the Ads add-on.