Company Leads

Retrieve leads associated with a company

get

Fetches a list of leads associated with the specified company. Supports pagination, date filtering, and additional filtering by profile, lead group, and lead ID.

Query parameters

company_idintegerRequired

The ID of the company for which to retrieve leads.

Example: 385

limitintegerRequired

The number of leads to retrieve per page.

Example: 10

pageintegerRequired

The page number to retrieve.

Example: 1

startintegerOptional

Start of the date range filter (Unix timestamp).

Example: 1700000000

endintegerOptional

End of the date range filter (Unix timestamp).

Example: 1723185083

profile_idintegerOptional

The ID of the profile to filter leads by.

Example: 21312

lead_group_idintegerOptional

The ID of the lead group to filter leads by.

Example: 101

lead_idintegerOptional

The ID of a specific lead to retrieve.

Example: 3178

Responses

200

A successful response with the list of leads.

application/json

get

/company/leads

HTTPcURLJavaScriptPython

GET /company/leads?company_id=385&limit=10&page=1 HTTP/1.1
Host: api.taag.co
Accept: */*

200

A successful response with the list 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
    }
  ]
}