goodleads.club

{
  "type": "object",
  "properties": {
    "list_id": {
      "type": "string",
      "description": "A saved list id (8 chars, a-z / 2-7). Pass this or states + filters, not both."
    },
    "states": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "State codes for an inline shape; omit for every live state."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Filters follow the one GoodLeads filter contract (85 fields; GET /api/v1/schema/attributes?include=grammar): a leaf is {\"field\", \"op\", \"value\"}; the top-level list is an implicit \"and\"; {\"op\": \"and\"|\"or\", \"filters\": [...]} nests one or more children and {\"op\": \"not\", \"filters\": [one child]} negates. Operators by field type — text: eq, neq, in, not_in, contains, does_not_contain, exists, missing; number: eq, neq, gt, gte, lt, lte, between, in, not_in, exists, missing; date: eq, neq, gt, gte, lt, lte, between, in, not_in, exists, missing; boolean: eq, neq; geo: within. Sort with [{field, dir}] over any of the 76 sortable fields. Keyless callers may not filter on contact_name, email_primary, phone_primary. Live states: CO, CT, FL, NY, OR, TX, VA. Records appear here the morning after the state posts them — speed is measured from publication, never from filing."
    },
    "include_held": {
      "type": "boolean",
      "description": "Include inactive-or-holding entities (default false)."
    },
    "include_existing": {
      "type": "boolean",
      "description": "Include existing businesses with a new filing (a registration, conversion, reinstatement, move or rename). Default false: Just started only, exactly as Browse and the file. Naming filing_kind or business_origin in filters widens on its own."
    },
    "lane": {
      "type": "string",
      "description": "all | best | contact — asks for a quote. For emailable now, contact with a has_email filter; for callable now, contact with has_phone."
    },
    "cap": {
      "type": "object",
      "description": "{type: \"count\"|\"budget\", value} — the dial the quote is solved against."
    }
  }
}