Passer au contenu principal
GET
List leads

Autorisations

Authorization
string
header
requis

API key created in the Agentova app (Settings → API), sent as Authorization: Bearer agk_live_…. One key = one workspace: the key determines the workspace, and no workspace identifier ever travels in requests. The Bearer scheme is case-insensitive. A revoked key is refused immediately.

Paramètres de requête

source
enum<string>

Only the leads from this source. Any other value is refused with 400 invalid_request.

  • widget: the chat widget of a website, or a lead entered manually in the Agentova app.
  • lead_ads: a Meta Lead Ads form.
  • telephony: a phone call handled by an Agentova telephony agent.
  • social: an Instagram or Facebook prospect who commented a post and then sent their contact details (email or phone) in a private message to the comment automation of an Agentova agent.
  • crm: an incoming contact of a connected CRM (HubSpot, Monday, Customer.io…) for which an automation of an Agentova agent ran.
Options disponibles:
widget,
social,
telephony,
lead_ads,
crm
agent_id
string

Only the leads of this agent, given as an opaque agt_… identifier. A value that does not look like an identifier issued by the API returns an empty page.

limit
integer
défaut:25

Integer from 1 to 100 (default 25). Out of range or not an integer: 400 invalid_request.

Plage requise: 1 <= x <= 100
cursor
string | null

Opaque cursor received in next_cursor. Missing, empty or equal to the literal word null: first page. Unreadable: 400 invalid_request.

Réponse

A page of leads

has_more
boolean
requis

Whether another page follows.

next_cursor
string | null
requis

Opaque cursor of the next page, to send back as cursor; null when there is no next page.

data
object[]
requis