Lead Search

Search Leads

get

Query parameters

querystringRequired

The search query string

company_idintegerRequired

The ID of the company associated with the leads

lead_group_idintegerOptional

The ID of the lead group to filter the search by (optional)

Responses

200

Successful search of leads.

application/json

get

/lead/search

HTTPcURLJavaScriptPython

GET /lead/search?query=text&company_id=1 HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful search of leads.

{
  "status": "success",
  "leads": [
    {
      "id": 3178,
      "user_id": 21140,
      "profile_id": null,
      "company_id": 385,
      "device_id": null,
      "contact_group_id": null,
      "name": "Test Auto Sync",
      "job": "",
      "company": "TESTAUTOSYNC INC.",
      "phone": "",
      "email": "[email protected]",
      "url": "",
      "address": "",
      "image": null,
      "description": "",
      "type": "lead",
      "file": null,
      "fav": null,
      "timestamp": 1723185083,
      "data_consent_given": 1,
      "token": "3178-GFw2anHV5ziTODhWmQEmDHTf4cyr5O0o",
      "profile_name": null,
      "image_profile": null,
      "profile_job": null,
      "device_description": null,
      "device_profile_id": null,
      "device_redirect": null,
      "labels": [
        "test1"
      ],
      "connected_device": [
        {}
      ],
      "connected_profile": null
    }
  ]
}