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

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": {}
}

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.