Skip to main content
GET
/
search
/
leads
Search leads
curl --request GET \
  --url https://app.leadconduit.com/search/leads \
  --header 'Authorization: Basic <encoded-value>'
{
  "hits": [
    {
      "lead_id": "5fd4371e940df5a34a3888b2",
      "flow_id": "5fd4371e940df5a34a3888b2",
      "flow_name": "Sales Leads",
      "source_id": "5fd4371e940df5a34a3888b2",
      "source_name": "A Corporation",
      "first_name": "George",
      "last_name": "Washington",
      "email": "georgew@gmail.com",
      "phone_1": "5125551212",
      "phone_2": "5125552222",
      "address_1": "123 Main street",
      "city": "Austin",
      "postal_code": "78704",
      "reference": "1990118214561",
      "state": "TX",
      "submission_timestamp": "2023-11-07T05:31:56Z",
      "highlight": {},
      "latest_event": {
        "id": "5fd4371e940df5a34a3888b2",
        "outcome": "success",
        "reason": "<string>",
        "type": "recipient",
        "vars": {
          "price": 123,
          "purchase_price": 123,
          "event_id": "636999a5a28de89048cd16fc"
        },
        "host": "<string>",
        "start_timestamp": 123,
        "end_timestamp": 123,
        "firehose": {
          "credential_id": "5fd4371e940df5a34a3888b2",
          "enabled": true,
          "bucket": "<string>",
          "prefix": "<string>",
          "services": {
            "aws": {
              "enabled": true,
              "credential_id": "5fd4371e940df5a34a3888b2",
              "bucket": "<string>",
              "prefix": "<string>"
            },
            "azure": {
              "enabled": true,
              "credential_id": "5fd4371e940df5a34a3888b2",
              "bucket": "<string>",
              "prefix": "<string>"
            }
          }
        },
        "ms": 123,
        "wait_ms": 123,
        "overhead_ms": 123,
        "lag_ms": 123,
        "total_ms": 123,
        "handler_version": "<string>",
        "version": "<string>",
        "cap_reached": true,
        "flow_ping_limits": {
          "id": "5fd4371e940df5a34a3888b2",
          "name": "<string>",
          "maximum": 123,
          "duration": 123,
          "duration_units": "<string>",
          "time_zone": "America/New_York",
          "created_at": "2023-11-07T05:31:56Z"
        },
        "source_ping_limits": {
          "id": "5fd4371e940df5a34a3888b2",
          "name": "<string>",
          "maximum": 123,
          "duration": 123,
          "duration_units": "<string>",
          "time_zone": "America/New_York",
          "created_at": "2023-11-07T05:31:56Z"
        },
        "ping_limit_reached": true,
        "expires_at": "2023-11-07T05:31:56Z",
        "step_id": "<string>",
        "caps": [
          {
            "id": "5fd438f91f0d12766e2bfee5",
            "type": "volume",
            "name": "Monthly leads from TX",
            "maximum": 1200,
            "duration": 2,
            "duration_units": "month",
            "rule_set": {
              "op": "and",
              "rules": [
                {
                  "lhv": "lead.state",
                  "op": "is equal to",
                  "rhv": "TX",
                  "id": "1aacd0",
                  "rule_set": "<unknown>"
                }
              ],
              "id": "0d144a"
            },
            "caps": "<array>",
            "time_zone": "America/New_York",
            "reason": "<string>",
            "created_at": "2020-11-23T11:41:52Z"
          }
        ],
        "caps_reached": true,
        "key": "<string>",
        "cost": 123,
        "purchase_price": 123,
        "sale_price": 123,
        "revenue": 123,
        "module_id": "<string>",
        "credential": {
          "id": "5fd4371e940df5a34a3888b2",
          "name": "<string>",
          "type": "user",
          "package": "<string>",
          "username": "<string>",
          "password": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "credential_updated": true,
        "package_version": "<string>",
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "id": "1aacd0",
              "rule_set": "<unknown>"
            }
          ],
          "id": "0d144a"
        },
        "mappings": [
          {
            "property": "<string>",
            "value": "<string>",
            "id": "1aacd0",
            "rule_set": {
              "op": "and",
              "rules": [
                {
                  "lhv": "lead.state",
                  "op": "is equal to",
                  "rhv": "TX",
                  "id": "1aacd0",
                  "rule_set": "<unknown>"
                }
              ],
              "id": "0d144a"
            }
          }
        ],
        "pricing": {
          "override": true,
          "prices": [
            {
              "amount": 123,
              "id": "<unknown>",
              "rule_set": {
                "op": "and",
                "rules": [
                  {
                    "lhv": "lead.state",
                    "op": "is equal to",
                    "rhv": "TX",
                    "id": "1aacd0",
                    "rule_set": "<unknown>"
                  }
                ],
                "id": "0d144a"
              }
            }
          ]
        },
        "transactions": [
          {
            "request": {
              "method": "POST",
              "uri": "https://app.leadconduit.com/flows/5fd4371e940df5a34a3888b2/sources/6369a0e534c9d4ebe142e0ef/submit",
              "version": "1.1",
              "headers": {
                "Content-Type": "application/json",
                "Accept": "application/json"
              },
              "body": "{\"email\":\"johndoe@email.com\",\"phone_1\":\"5127891111\"}",
              "timestamp": 123
            },
            "response": {
              "version": "1.1",
              "headers": {
                "Content-Type": "application/json",
                "Accept": "application/json"
              },
              "body": "{\"outcome\":\"success\",\"lead\":{\"id\":\"63cc6f0e55254d7d1c4c3037\"}}",
              "timestamp": 123,
              "status": 201,
              "status_text": "Created"
            },
            "ms": 123
          }
        ]
      }
    }
  ],
  "total": 123
}

Authorizations

​
Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Query Parameters

​
query
string

text to search for

​
sort_by
enum<string>

One of the following field names: lead_id, submission_timestamp, first_name, last_name, email, phone_1, phone_2, address_1, city, state, postal_code, reference

Available options:
lead_id,
submission_timestamp,
first_name,
last_name,
email,
phone_1,
phone_2,
address_1,
city,
state,
postal_code,
reference
​
sort_dir
enum<string>

The sort direction: "asc" or "desc", default is by relevance

Available options:
asc,
desc
​
from
integer

The starting offset of leads to return in the matching result set, zero-based

​
limit
integer

The maximum number of leads to return (maximum is 100, default is 10)

Response

200 - application/json

OK

​
hits
Lead Search Result · object[]
​
total
number