List submitted leads

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/leads', 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/leads",
  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/leads"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/leads")

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

{
  "leads": [
    {
      "adId": "<string>",
      "adsetId": "<string>",
      "campaignId": "<string>",
      "connectionId": "<string>",
      "consents": [
        {}
      ],
      "contactId": "<string>",
      "conversationId": "<string>",
      "createdTime": "<string>",
      "currency": "<string>",
      "fieldData": [
        {}
      ],
      "fields": {},
      "firstContactedAt": "2023-11-07T05:31:56Z",
      "formId": "<string>",
      "formName": "<string>",
      "id": "<string>",
      "isOrganic": true,
      "leadgenId": "<string>",
      "status": "new",
      "statusChangedAt": "2023-11-07T05:31:56Z",
      "value": 123,
      "webhookDeliveredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "lastCheckedAt": "2023-11-07T05:31:56Z",
    "lastUpdated": "2023-11-07T05:31:56Z"
  },
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  },
  "status": "<string>"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

AIsa Ads

List submitted leads

Lead Gen. Read only. Lists the leads submitted through your Meta or LinkedIn lead forms, newest first. Requires the Ads add-on. ### Meta (default) ### LinkedIn When `connectionId` is a LinkedIn ads account, `adAccountId` is required. Reading LinkedIn responses needs the `r_marketing_leadgen_automation` permission. Accounts connected before it was added must reconnect.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

GET

https://api.aisa.one

apis

ads

leads

List submitted leads

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/leads', 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/leads",
  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/leads"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/leads")

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

{
  "leads": [
    {
      "adId": "<string>",
      "adsetId": "<string>",
      "campaignId": "<string>",
      "connectionId": "<string>",
      "consents": [
        {}
      ],
      "contactId": "<string>",
      "conversationId": "<string>",
      "createdTime": "<string>",
      "currency": "<string>",
      "fieldData": [
        {}
      ],
      "fields": {},
      "firstContactedAt": "2023-11-07T05:31:56Z",
      "formId": "<string>",
      "formName": "<string>",
      "id": "<string>",
      "isOrganic": true,
      "leadgenId": "<string>",
      "status": "new",
      "statusChangedAt": "2023-11-07T05:31:56Z",
      "value": 123,
      "webhookDeliveredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "lastCheckedAt": "2023-11-07T05:31:56Z",
    "lastUpdated": "2023-11-07T05:31:56Z"
  },
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  },
  "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/leads
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/leads
connectionId: query; required
formId: query; optional
status: query; optional
campaignId: query; optional
platform: query; optional
q: query; optional
adAccountId: query; optional
limit: query; optional
since: query; optional
cursor: query; optional
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "get_aisa_ads_apis_v1_ads_leads",
  "method": "GET",
  "path": "/apis/v1/ads/leads",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "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": "Filter to a single lead form.",
      "in": "query",
      "name": "formId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Meta only. Comma-separated lead statuses: new, contacted, unreachable, qualified, converted, disqualified.",
      "in": "query",
      "name": "status",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Meta only. The platform campaign id the lead came from. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
      "in": "query",
      "name": "campaignId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "meta skips the LinkedIn live fetch; linkedin requires connectionId to be a LinkedIn ads connection (400 otherwise).",
      "in": "query",
      "name": "platform",
      "required": false,
      "schema": {
        "enum": [
          "meta",
          "linkedin"
        ],
        "type": "string"
      }
    },
    {
      "description": "Meta only. Case-insensitive text search over the lead's answers and the form name.",
      "in": "query",
      "name": "q",
      "required": false,
      "schema": {
        "maxLength": 200,
        "type": "string"
      }
    },
    {
      "description": "LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder).",
      "in": "query",
      "name": "adAccountId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 25,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Unix seconds; only leads created at/after this timestamp. Millisecond timestamps return 400 with instructions to divide by 1000.",
      "in": "query",
      "name": "since",
      "required": false,
      "schema": {
        "maximum": 253402300799,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Keyset cursor from a previous response's pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset).",
      "in": "query",
      "name": "cursor",
      "required": false,
      "schema": {
        "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

Authorization

string

header

required

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

Query Parameters

connectionId

string

required

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]+$

formId

string

Filter to a single lead form.

status

string

Meta only. Comma-separated lead statuses: new, contacted, unreachable, qualified, converted, disqualified.

campaignId

string

Meta only. The platform campaign id the lead came from. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

platform

enum<string>

meta skips the LinkedIn live fetch; linkedin requires connectionId to be a LinkedIn ads connection (400 otherwise).

Available options:

meta,

linkedin

string

Meta only. Case-insensitive text search over the lead's answers and the form name.

Maximum string length: 200

adAccountId

string

LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder).

limit

integer

default:25

Required range: 1 <= x <= 100

since

integer

Unix seconds; only leads created at/after this timestamp. Millisecond timestamps return 400 with instructions to divide by 1000.

Required range: 1 <= x <= 253402300799

cursor

string

Keyset cursor from a previous response's pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset).

Response

Lead list.

leads

object[]

Show child attributes

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Response

Request contract

Cost and request rules