Get a lead form
curl --request GET \
--url https://api.aisa.one/apis/v1/ads/lead-forms/{formId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/ads/lead-forms/{formId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/ads/lead-forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/lead-forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/ads/lead-forms/{formId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/ads/lead-forms/{formId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/lead-forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"form": {
"allow_organic_lead": true,
"block_display_for_non_targeted_viewer": true,
"context_card": {
"button_text": "<string>",
"content": [
"<string>"
],
"cover_photo": {
"id": "<string>"
},
"id": "<string>",
"style": "LIST_STYLE",
"title": "<string>"
},
"created_time": "2023-11-07T05:31:56Z",
"expired_leads_count": 123,
"follow_up_action_text": "<string>",
"follow_up_action_url": "<string>",
"id": "<string>",
"is_optimized_for_quality": true,
"leads_count": 123,
"legal_content": {
"custom_disclaimer": {},
"id": "<string>",
"privacy_policy": {
"link_text": "<string>",
"url": "<string>"
}
},
"locale": "<string>",
"name": "<string>",
"organic_leads_count": 123,
"page_id": "<string>",
"privacy_policy_url": "<string>",
"question_page_custom_headline": "<string>",
"questions": [
{
"conditional_questions_choices": [
{}
],
"conditional_questions_group_id": "<string>",
"dependent_conditional_questions": [
{}
],
"id": "<string>",
"inline_context": "<string>",
"key": "<string>",
"label": "<string>",
"options": [
{}
],
"type": "<string>"
}
],
"status": "<string>",
"thank_you_page": {
"body": "<string>",
"business_phone_number": "<string>",
"button_text": "<string>",
"button_type": "<string>",
"country_code": "<string>",
"enable_messenger": true,
"id": "<string>",
"lead_gen_use_case": "<string>",
"status": "<string>",
"title": "<string>",
"website_url": "<string>"
},
"tracking_parameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"status": "<string>"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
Get a lead form
Lead Gen. Read only. Shows a lead form in full, including its questions and thank-you page. Returns the full form, including the thank-you page, so a form can be diffed against what was created. Meta forms are scoped to the Page the connectionId manages: a form on any other Page is a 404, never a read.
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
GET
https://api.aisa.one
/
apis
/
v1
/
ads
/
lead-forms
/
{formId}
Get a lead form
curl --request GET \
--url https://api.aisa.one/apis/v1/ads/lead-forms/{formId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/ads/lead-forms/{formId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/ads/lead-forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/lead-forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/ads/lead-forms/{formId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/ads/lead-forms/{formId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/lead-forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"form": {
"allow_organic_lead": true,
"block_display_for_non_targeted_viewer": true,
"context_card": {
"button_text": "<string>",
"content": [
"<string>"
],
"cover_photo": {
"id": "<string>"
},
"id": "<string>",
"style": "LIST_STYLE",
"title": "<string>"
},
"created_time": "2023-11-07T05:31:56Z",
"expired_leads_count": 123,
"follow_up_action_text": "<string>",
"follow_up_action_url": "<string>",
"id": "<string>",
"is_optimized_for_quality": true,
"leads_count": 123,
"legal_content": {
"custom_disclaimer": {},
"id": "<string>",
"privacy_policy": {
"link_text": "<string>",
"url": "<string>"
}
},
"locale": "<string>",
"name": "<string>",
"organic_leads_count": 123,
"page_id": "<string>",
"privacy_policy_url": "<string>",
"question_page_custom_headline": "<string>",
"questions": [
{
"conditional_questions_choices": [
{}
],
"conditional_questions_group_id": "<string>",
"dependent_conditional_questions": [
{}
],
"id": "<string>",
"inline_context": "<string>",
"key": "<string>",
"label": "<string>",
"options": [
{}
],
"type": "<string>"
}
],
"status": "<string>",
"thank_you_page": {
"body": "<string>",
"business_phone_number": "<string>",
"button_text": "<string>",
"button_type": "<string>",
"country_code": "<string>",
"enable_messenger": true,
"id": "<string>",
"lead_gen_use_case": "<string>",
"status": "<string>",
"title": "<string>",
"website_url": "<string>"
},
"tracking_parameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"status": "<string>"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: GET /apis/v1/ads/lead-forms/{formId}
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/lead-forms/{formId} - formId: path; required
- connectionId: query; required
- fields: query; optional
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "get_aisa_ads_apis_v1_ads_lead_forms_formid",
"method": "GET",
"path": "/apis/v1/ads/lead-forms/{formId}",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).",
"in": "path",
"name": "formId",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
"in": "query",
"name": "connectionId",
"required": true,
"schema": {
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
}
},
{
"description": "Meta only. A Graph field selection passed through verbatim to GET /{form-id}, replacing the default projection, so fields Meta adds later are reachable without an API change. Field names, commas and {} expansion only.",
"in": "query",
"name": "fields",
"required": false,
"schema": {
"maxLength": 2000,
"type": "string"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
"kind": "no_customer_charge"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
Query Parameters
The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.
Pattern:
^adc_[0-9A-Za-z]+$Meta only. A Graph field selection passed through verbatim to GET /{form-id}, replacing the default projection, so fields Meta adds later are reachable without an API change. Field names, commas and {} expansion only.
Maximum string length:
2000