List ReadyLink leads

Returns the user’s leads from ReadyLinks, with filters, pagination, and sort. Response is wrapped: { data: Lead[], pagination: {...}, filters: {...} }.

Lead surveyStatus (the survey’s own status) takes values pending, completed, converted, archived. The status query parameter (active, archived, all) toggles between active vs archived view.

GET /api/lead-generation/leads

List ReadyLink leads

cURL

curl --request GET \
  --url https://app.auditynow.com/api/lead-generation/leads \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/lead-generation/leads"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://app.auditynow.com/api/lead-generation/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://app.auditynow.com/api/lead-generation/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://app.auditynow.com/api/lead-generation/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))

}

HttpResponse<String> response = Unirest.get("https://app.auditynow.com/api/lead-generation/leads")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/lead-generation/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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "clientName": "<string>",
      "businessName": "<string>",
      "clientEmail": "<string>",
      "clientPhone": "<string>",
      "aiReadinessScore": 123,
      "compositeScore": 123,
      "webResearchStatus": "<string>",
      "staticSlugId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "filters": {}
}

{
  "error": "Unauthorized"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Query Parameters

status · enum<string> · default: active

Available options: active, archived, all

staticSlugId · string<uuid>

Filter to leads from a specific ReadyLink (UUID).

limit · integer · default: 50

Required range: 1 <= x <= 500

offset · integer · default: 0

Required range: x >= 0

sortBy · enum<string> · default: created_at

Available options: created_at, updated_at, client_name, business_name, ai_readiness_score, composite_score

sortOrder · enum<string> · default: desc

Available options: asc, desc

Response

200

application/json

Paginated leads

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes

filters · object

Echo of the filters applied.