Naar de inhoud

Leads

GET /api/v1/leads en /api/v1/leads/{id}: leads ophalen met filters en recente gebeurtenissen.

Haal de leads van je werkruimte op, bijvoorbeeld om ze in je CRM bij te werken. Je kunt filteren op status, fase en het moment van de laatste wijziging, en één lead ophalen met zijn recente gebeurtenissen.

Leads ophalen

GET https://leadforge.nl/api/v1/leads

Vraagt read

Leads van je werkruimte, nieuwste eerst.

Queryparameters

NaamTypeStandaardBeschrijving
limitgetal50Aantal leads per pagina, hoogstens 200.
cursortekstDe nextCursor van de vorige pagina.
sincedatumAlleen leads met updatedAt vanaf dit moment, als ISO-datum. Een ongeldige datum wordt genegeerd.
statustekstAlleen leads met precies deze status. Zie de waarden hieronder.
stagetekstAlleen leads met precies deze pipelineStage. Zie de waarden hieronder.
  • De lijst staat op createdAt, nieuwste eerst.
  • Een waarde van status of stage die niet bestaat, geeft een lege lijst en geen fout.
  • Gearchiveerde leads komen ook mee.

Hoe je doorbladert staat in Paginering en filters.

Verzoek
curl "https://leadforge.nl/api/v1/leads?status=geinteresseerd&since=2026-11-01&limit=50" \
  -H "Authorization: Bearer LF_LIVE_SLEUTEL"
JSON Antwoord 200
{
	"data": [
		{
			"id": "<lead-id>",
			"firstName": "Anna",
			"lastName": "Jansen",
			"email": "anna@voorbeeld.nl",
			"phone": null,
			"title": "Marketingmanager",
			"company": "Voorbeeld BV",
			"companyDomain": "voorbeeld.nl",
			"linkedIn": "https://www.linkedin.com/in/voorbeeld",
			"status": "geinteresseerd",
			"pipelineStage": "geinteresseerd",
			"leadScore": 0,
			"createdAt": "2026-11-02T09:14:00.000Z",
			"updatedAt": "2026-11-05T13:40:00.000Z"
		}
	],
	"hasMore": false,
	"nextCursor": null
}
StatusCodeWanneer
200Een pagina met leads, ook als die leeg is.
401unauthorizedGeen geldige sleutel.
403forbiddenDe sleutel heeft geen read, of hoort niet bij één werkruimte.
429rate_limitedMeer dan 120 verzoeken per minuut.

Eén lead ophalen

GET https://leadforge.nl/api/v1/leads/{id}

Vraagt read

Eén lead met zijn twintig nieuwste gebeurtenissen.

Padparameters

NaamTypeBeschrijving
id*(verplicht)tekst (uuid)Het id van de lead.

* verplicht

Het antwoord heeft alle velden van een lead en daarnaast events: hoogstens 20 gebeurtenissen, nieuwste eerst.

Velden

NaamTypeBeschrijving
events[].idtekst (uuid)Het id van de gebeurtenis.
events[].signalTypetekstDe soort gebeurtenis.
events[].occurredAtdatum (ISO)Wanneer de gebeurtenis plaatsvond.
curl
curl https://leadforge.nl/api/v1/leads/<lead-id> \
  -H "Authorization: Bearer LF_LIVE_SLEUTEL"
JSON Antwoord 200
{
	"data": {
		"id": "<lead-id>",
		"firstName": "Anna",
		"lastName": "Jansen",
		"...": "alle velden van een lead",
		"events": [
			{
				"id": "<gebeurtenis-id>",
				"signalType": "<soort gebeurtenis>",
				"occurredAt": "2026-11-05T13:40:00.000Z"
			}
		]
	}
}
StatusCodeWanneer
200De lead met zijn gebeurtenissen.
404not_foundLead niet gevonden. Het id bestaat niet in je werkruimte of is geen geldig id.
401unauthorizedGeen geldige sleutel.
403forbiddenDe sleutel heeft geen read, of hoort niet bij één werkruimte.
429rate_limitedMeer dan 120 verzoeken per minuut.

Goed om te weten

signalType is vrije tekst. Er is geen vaste lijst van waarden, dus laat je code niet afhangen van een bepaalde waarde.

Velden van een lead

Velden

NaamTypeBeschrijving
idtekst (uuid)Het id van de lead.
firstNametekst of nullVoornaam.
lastNametekst of nullAchternaam.
emailtekst of nullE-mailadres.
phonetekst of nullTelefoonnummer.
titletekst of nullFunctie.
companytekst of nullNaam van het bedrijf.
companyDomaintekst of nullDomein van het bedrijf.
linkedIntekst of nullAdres van het LinkedIn-profiel.
statustekstDe status van de lead, in het Nederlands. Zie hieronder.
pipelineStagetekstDe fase in de pijplijn, in het Nederlands. Zie hieronder.
leadScoregeheel getalDe startscore van de lead, standaard 0. Dit is niet de leadscore die je op Leads ziet: die telt ook contact en bezoeken mee en komt niet uit de API.
createdAtdatum (ISO)Wanneer de lead is aangemaakt.
updatedAtdatum (ISO)Wanneer de lead voor het laatst is gewijzigd.

Waarden van status

Waarde
nieuw
benaderd
geinteresseerd
wachtend
afspraak
offerte
gewonnen
verloren
ongekwalificeerd

Waarden van pipelineStage

Waarde
nieuw
benaderd
geinteresseerd
afspraak
offerte

Goed om te weten

De waarden komen in het Nederlands terug en zonder trema: geinteresseerd, niet geïnteresseerd. Gebruik dezelfde spelling in de filters status en stage.

Verder lezen

  • Fasen en bronnen
  • Leadscore: hoe de score op het scherm wordt opgebouwd, met de startscore als een van de onderdelen
  • lead.created: een seintje bij elke nieuwe lead met een LinkedIn-profiel