Skip to main content
Facebook IntegrationVersion: v3

Get conversation forms

GET/ad-publishing/facebook/conversation-forms

Retrieve Facebook conversation lead forms for a location. Without limit the response is a plain array. When limit is provided (max 100) the response is a paginated { conversationForms, paging } envelope; pass after (from paging.next) to fetch the next batch.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

locationIdstringrequired

Location identifier

Example:loc_abc123
limitstring

Page size for a paginated fetch (max 100). When set, the response is a { conversationForms, paging } envelope instead of a plain array.

Example:25
afterstring

Opaque cursor for the next batch, taken from the previous response paging.next

Example:25

Response

application/json

A plain array of conversation forms (default), or a { conversationForms, paging } envelope when limit is provided. Sorted newest first in both cases.

oneOf
  • Array items
    • idstringrequired

    Conversation form id

    Example:6a831fb01aa9a84ff992aefc
    namestringrequired

    Form name

    Example:Untitled form 17 Aug 26, 08:20 PM
    textstringrequired

    Opening message shown when the conversation starts

    Example:Hi there! Please let us know how we can help you.
    locationIdstringrequired

    Owning location

    Example:fRMewNQIxSyZ5R4nQyit
    questionsobject[]required

    Prompt and canned-reply pairs

    createdAtstringrequired

    Creation time, ISO-8601

    Example:2026-08-17T14:50:24.444Z
    updatedAtstringrequired

    Last modification time, ISO-8601

    Example:2026-08-17T14:50:24.444Z