Get Lead Forms

This endpoint retrieves all lead form assets linked to the user’s Google Ads account. It returns essential details like the lead form name and asset ID, which can be used when setting up or managing lead generation campaigns. Use this to view and select from your existing lead forms.

POST /gads/get_lead_forms

Get Lead Forms

cURL

curl --request POST \
  --url https://public.plai.io/gads/get_lead_forms \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "leadFormInfo": [
      {
        "leadFormAssetId": "<string>",
        "name": "<string>"
      }
    ],
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results Object

success · boolean

Indicates whether the specific operation or API action was successful.

leadFormInfo · object[]

Show Lead Form Info Object

leadFormAssetId · string

Lead form Asset ID

name · string

Name of the lead form

error · string

Error string if something went wrong