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.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location identifier

limit string

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

after string

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

application/json

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

application/json

Schema

Schema

oneOf
• object[]
• PaginatedFacebookConversationFormsDTO
Array [
idstringrequired
Conversation form id
namestringrequired
Form name
textstringrequired
Opening message shown when the conversation starts
locationIdstringrequired
Owning location
questionsobject[]required
Prompt and canned-reply pairs
createdAtstringrequired
Creation time, ISO-8601
updatedAtstringrequired
Last modification time, ISO-8601
]

Example (auto)

[
  {
    "id": "6a831fb01aa9a84ff992aefc",
    "name": "Untitled form 17 Aug 26, 08:20 PM",
    "text": "Hi there! Please let us know how we can help you.",
    "locationId": "fRMewNQIxSyZ5R4nQyit",
    "questions": [
      {
        "question": "Your question",
        "response": "Click the link below to view the product page.",
        "_id": "6a831fb01aa9a84ff992aefd"
      }
    ],
    "createdAt": "2026-08-17T14:50:24.444Z",
    "updatedAt": "2026-08-17T14:50:24.444Z"
  }
]