> ## 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

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

![Facebook](https://stackone-logos.com/api/facebook/filled/svg)

Previewv1.1.0[See changelog](https://docs.stackone.com/connectors/facebook/changelog.md)

[80 actions](#actions) · 1 auth method

Advertising

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/facebook/guides/connector-profile/oauth-2-0.md)
>
> Requires a Meta App with Facebook Login for Business configured. Business Verification and App Review are required for A...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

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

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/facebook/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

ads\_management

ads\_read

business\_management

leads\_retrieval

pages\_manage\_ads

pages\_manage\_engagement

pages\_manage\_metadata

pages\_manage\_posts

pages\_read\_engagement

pages\_show\_list

public\_profile

read\_insights

No scopes found

80 actions

ActionDescriptionRequired scopes

List Ad Accounts`facebook_list_ad_accounts`

List all ad accounts accessible to the authenticated user

`ads_read`

Get Ad Account`facebook_get_ad_account`

Get details for a specific ad account

`ads_read`

Get Ad Account Insights`facebook_get_ad_account_insights`

Get performance insights for a specific ad account

`ads_read`

Update Ad Account`facebook_update_ad_account`

Update an existing ad account

`ads_management`

List Ad Creatives`facebook_list_ad_creatives`

List all ad creatives in an ad account

`ads_read`

Get Ad Creative`facebook_get_ad_creative`

Get details for a specific ad creative

`ads_read`

Create Ad Creative`facebook_create_ad_creative`

Create a new ad creative

`ads_management`

Delete Ad Creative`facebook_delete_ad_creative`

Delete an ad creative

`ads_management`

List Ads By Account`facebook_list_ads_by_account`

List all ads in an ad account

`ads_read`

List Ads By Ad Set`facebook_list_ads_by_adset`

List all ads for a specific ad set

`ads_read`

Get Ad`facebook_get_ad`

Get details for a specific ad

`ads_read`

Create Ad`facebook_create_ad`

Create a new ad

`ads_management`

Update Ad`facebook_update_ad`

Update an existing ad

`ads_management`

Delete Ad`facebook_delete_ad`

Delete an ad

`ads_management`

Get Ad Insights`facebook_get_ad_insights`

Get performance insights for a specific ad

`ads_read`

List Ad Sets By Account`facebook_list_adsets_by_account`

List all ad sets in an ad account

`ads_read`

List Ad Sets By Campaign`facebook_list_adsets_by_campaign`

List all ad sets for a specific campaign

`ads_read`

Get Ad Set`facebook_get_adset`

Get details for a specific ad set

`ads_read`

Create Ad Set`facebook_create_adset`

Create a new ad set with targeting

`ads_management`

Update Ad Set`facebook_update_adset`

Update an existing ad set

`ads_management`

Delete Ad Set`facebook_delete_adset`

Delete an ad set

`ads_management`

Get Ad Set Insights`facebook_get_adset_insights`

Get performance insights for a specific ad set

`ads_read`

List Pixels`facebook_list_ads_pixels`

List all pixels for an ad account

`ads_read`

Get Pixel`facebook_get_ads_pixel`

Get pixel details and configuration

`ads_read`

Create Pixel`facebook_create_ads_pixel`

Create new tracking pixel

`ads_management`

List Page Albums`facebook_list_page_albums`

List photo albums for a Facebook Page

`pages_read_engagement`

Get Album`facebook_get_album`

Get details for a specific album

`pages_read_engagement`

Create Page Album`facebook_create_page_album`

Create a photo album on a Facebook Page

`pages_manage_posts`

Get Business`facebook_get_business`

Get details for a specific Business

`business_management`

List Business Owned Ad Accounts`facebook_list_business_owned_ad_accounts`

List ad accounts owned by a Business

`business_management`

List Business Client Ad Accounts`facebook_list_business_client_ad_accounts`

List ad accounts a Business has access to as a client

`business_management`

List Campaigns`facebook_list_campaigns`

List all campaigns in an ad account

`ads_read`

Get Campaign`facebook_get_campaign`

Get details for a specific campaign

`ads_read`

Create Campaign`facebook_create_campaign`

Create a new advertising campaign

`ads_management`

Update Campaign`facebook_update_campaign`

Update an existing campaign

`ads_management`

Delete Campaign`facebook_delete_campaign`

Delete a campaign

`ads_management`

Get Campaign Insights`facebook_get_campaign_insights`

Get performance insights for a specific campaign

`ads_read`

List Post Comments`facebook_list_post_comments`

List comments on a post or object

`pages_read_engagement`

Get Comment`facebook_get_comment`

Get details for a specific comment

`pages_read_engagement`

Create Comment`facebook_create_comment`

Add a comment to a post or object

`pages_manage_engagement`

Update Comment`facebook_update_comment`

Edit or hide an existing comment

`pages_manage_engagement`

Delete Comment`facebook_delete_comment`

Delete a comment

`pages_manage_engagement`

List Custom Audiences`facebook_list_custom_audiences`

List all custom audiences in an ad account

`ads_management`

Get Custom Audience`facebook_get_custom_audience`

Get details for a specific custom audience

`ads_management`

Create Custom Audience`facebook_create_custom_audience`

Create a new custom audience

`ads_management`

Update Custom Audience`facebook_update_custom_audience`

Update an existing custom audience

`ads_management`

Delete Custom Audience`facebook_delete_custom_audience`

Delete a custom audience

`ads_management`

Get Page Insights`facebook_get_page_insights`

Get performance insights for a Page

`read_insights``pages_read_engagement`

Get Post Insights`facebook_get_post_insights`

Get performance insights for a Page post

`read_insights``pages_read_engagement`

List Lead Gen Forms`facebook_list_leadgen_forms`

List lead generation forms for a Facebook Page

`pages_manage_ads`

Get Lead Gen Form`facebook_get_leadgen_form`

Get details for a specific lead generation form

`pages_manage_ads`

Create Lead Gen Form`facebook_create_leadgen_form`

Create a lead generation form for a Facebook Page

`pages_manage_ads`

List Leads By Ad`facebook_list_leads_by_ad`

Get all leads for a specific ad

`leads_retrieval``pages_manage_ads`

List Leads By Form`facebook_list_leads_by_form`

Get all leads for a specific form

`leads_retrieval``pages_manage_ads`

Get Lead`facebook_get_lead`

Get details for a specific lead

`leads_retrieval``pages_manage_ads`

Get Page`facebook_get_page`

Get details for a specific Page

`pages_read_engagement`

Update Page`facebook_update_page`

Update settings and metadata for a Page

`pages_manage_metadata`

List Page Settings`facebook_list_page_settings`

List the settings for a Page

`pages_manage_metadata`

List Page Photos`facebook_list_page_photos`

List photos for a Facebook Page

`pages_read_engagement`

Get Photo`facebook_get_photo`

Get details for a specific photo

`pages_read_engagement`

Create Page Photo`facebook_create_page_photo`

Upload a photo to a Facebook Page

`pages_manage_posts`

Delete Photo`facebook_delete_photo`

Delete a photo

`pages_manage_posts`

List Page Feed`facebook_list_page_feed`

List the feed of posts on a Facebook Page

`pages_read_engagement`

List Page Posts`facebook_list_page_posts`

List posts published by a Facebook Page

`pages_read_engagement`

Get Post`facebook_get_post`

Get details for a specific Page post

`pages_read_engagement`

Create Page Post`facebook_create_page_post`

Publish a new post to a Facebook Page

`pages_manage_posts``pages_manage_engagement`

Update Post`facebook_update_post`

Update the message of an existing Page post

`pages_manage_posts``pages_manage_engagement`

Delete Post`facebook_delete_post`

Delete a Page post

`pages_manage_posts``pages_manage_engagement`

List Business System Users`facebook_list_business_system_users`

List system users for a Business

`business_management`

Create Business System User`facebook_create_business_system_user`

Create a system user for a Business

`business_management`

List System User Assigned Users`facebook_list_system_user_assigned_users`

List users assigned to a system user

`business_management`

Get Me`facebook_get_me`

Get the profile of the authenticated user. Retrieving the email field requires the `email` scope to be granted.

`public_profile`

Get User`facebook_get_user`

Get the profile of a specific user. Retrieving the email field requires the `email` scope to be granted.

`public_profile`

List My Accounts`facebook_list_my_accounts`

List the Pages managed by the authenticated user

`pages_show_list`

List User Accounts`facebook_list_user_accounts`

List the Pages managed by a specific user

`pages_show_list`

List User Businesses`facebook_list_user_businesses`

List the Business Manager accounts a user belongs to

`business_management`

List Page Videos`facebook_list_page_videos`

List videos for a Facebook Page

`pages_read_engagement`

Get Video`facebook_get_video`

Get details for a specific video

`pages_read_engagement`

Create Page Video`facebook_create_page_video`

Upload a video to a Facebook Page

`pages_manage_posts`

Delete Video`facebook_delete_video`

Delete a video

`pages_manage_posts`


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