> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Facebook Lead Ads

> How to set up the Facebook Lead Ads connector, plus the actions that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/facebook/filled/svg" alt="Facebook Lead Ads" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-preview connector-page-stage-tag">Preview</span><span>v1.0.0</span></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">8 actions</a> · 2 auth methods</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Advertising</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · OAuth 2.0" href="/connectors/facebookleadads/guides/connector-profile/oauth-2-0" icon="https://stackone-logos.com/api/facebook/filled/svg" horizontal>
        Requires a Meta App with Facebook Login for Business configured, the leads\_retrieval and pages\_manage\_ads permissions, a...
      </Card>

      <Card title="Connector Profile · System User Access Token" href="/connectors/facebookleadads/guides/connector-profile/system-user-access-token" icon="https://stackone-logos.com/api/facebook/filled/svg" horizontal>
        For server-to-server lead sync without a browser OAuth flow. Generate a System User access token in Meta Business Settin...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

    See the guide for the authentication type chosen in the Connector Profile:

    <Columns cols={2}>
      <Card title="Link Account · OAuth 2.0" href="/connectors/facebookleadads/guides/link-account/oauth-2-0" icon="https://stackone-logos.com/api/facebook/filled/svg" horizontal />

      <Card title="Link Account · System User Access Token" href="/connectors/facebookleadads/guides/link-account/system-user-access-token" icon="https://stackone-logos.com/api/facebook/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />

      <div className="connector-actions-scopes" data-connector-actions-scopes>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-scopes-toggle aria-expanded="false">
          <span>Scopes<span data-connector-actions-scopes-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-scope-search placeholder="Search scopes..." aria-label="Search scopes" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-scopes-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-scopes-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="leads_retrieval" data-connector-actions-scope-filter />

            <span>leads\_retrieval</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="pages_manage_ads" data-connector-actions-scope-filter />

            <span>pages\_manage\_ads</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="pages_show_list" data-connector-actions-scope-filter />

            <span>pages\_show\_list</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="public_profile" data-connector-actions-scope-filter />

            <span>public\_profile</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-scopes-empty hidden>No scopes found</div>
        </div>
      </div>
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>8 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid connector-meta-library-grid--three-col">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
        <div className="meta-library-grid-header-cell">Required scopes</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_list_leadgen_forms" data-action-label="List Lead Gen Forms" data-action-scopes="pages_manage_ads" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Lead Gen Forms</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_list_leadgen_forms" aria-label="Copy facebookleadads_list_leadgen_forms"><code className="connector-page-code">facebookleadads\_list\_leadgen\_forms</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List lead generation forms for a Facebook Page</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="pages_manage_ads" aria-label="Copy scope pages_manage_ads"><code className="connector-page-code">pages\_manage\_ads</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_get_leadgen_form" data-action-label="Get Lead Gen Form" data-action-scopes="pages_manage_ads" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Lead Gen Form</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_get_leadgen_form" aria-label="Copy facebookleadads_get_leadgen_form"><code className="connector-page-code">facebookleadads\_get\_leadgen\_form</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get details for a specific lead generation form</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="pages_manage_ads" aria-label="Copy scope pages_manage_ads"><code className="connector-page-code">pages\_manage\_ads</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_create_leadgen_form" data-action-label="Create Lead Gen Form" data-action-scopes="pages_manage_ads" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Lead Gen Form</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_create_leadgen_form" aria-label="Copy facebookleadads_create_leadgen_form"><code className="connector-page-code">facebookleadads\_create\_leadgen\_form</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a lead generation form for a Facebook Page</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="pages_manage_ads" aria-label="Copy scope pages_manage_ads"><code className="connector-page-code">pages\_manage\_ads</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_list_leads_by_ad" data-action-label="List Leads By Ad" data-action-scopes="leads_retrieval,pages_manage_ads" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Leads By Ad</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_list_leads_by_ad" aria-label="Copy facebookleadads_list_leads_by_ad"><code className="connector-page-code">facebookleadads\_list\_leads\_by\_ad</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get all leads for a specific ad</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="leads_retrieval" aria-label="Copy scope leads_retrieval"><code className="connector-page-code">leads\_retrieval</code></button><button type="button" className="connector-page-code-button" data-copy="pages_manage_ads" aria-label="Copy scope pages_manage_ads"><code className="connector-page-code">pages\_manage\_ads</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_list_leads_by_form" data-action-label="List Leads By Form" data-action-scopes="leads_retrieval,pages_manage_ads" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Leads By Form</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_list_leads_by_form" aria-label="Copy facebookleadads_list_leads_by_form"><code className="connector-page-code">facebookleadads\_list\_leads\_by\_form</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get all leads for a specific form</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="leads_retrieval" aria-label="Copy scope leads_retrieval"><code className="connector-page-code">leads\_retrieval</code></button><button type="button" className="connector-page-code-button" data-copy="pages_manage_ads" aria-label="Copy scope pages_manage_ads"><code className="connector-page-code">pages\_manage\_ads</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_get_lead" data-action-label="Get Lead" data-action-scopes="leads_retrieval,pages_manage_ads" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Lead</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_get_lead" aria-label="Copy facebookleadads_get_lead"><code className="connector-page-code">facebookleadads\_get\_lead</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get details for a specific lead</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="leads_retrieval" aria-label="Copy scope leads_retrieval"><code className="connector-page-code">leads\_retrieval</code></button><button type="button" className="connector-page-code-button" data-copy="pages_manage_ads" aria-label="Copy scope pages_manage_ads"><code className="connector-page-code">pages\_manage\_ads</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_get_me" data-action-label="Get Me" data-action-scopes="public_profile" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Me</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_get_me" aria-label="Copy facebookleadads_get_me"><code className="connector-page-code">facebookleadads\_get\_me</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the profile of the authenticated user. Retrieving the email field requires the `email` scope to be granted.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="public_profile" aria-label="Copy scope public_profile"><code className="connector-page-code">public\_profile</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="facebookleadads_list_my_accounts" data-action-label="List My Accounts" data-action-scopes="pages_show_list" data-action-auth="OAuth 2.0,System User Access Token" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[],&#x22;System User Access Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List My Accounts</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="facebookleadads_list_my_accounts" aria-label="Copy facebookleadads_list_my_accounts"><code className="connector-page-code">facebookleadads\_list\_my\_accounts</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the Pages managed by the authenticated user</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="pages_show_list" aria-label="Copy scope pages_show_list"><code className="connector-page-code">pages\_show\_list</code></button></div>
        </div>
      </div>
    </div>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.