De API is opgedeeld in modules. Met dit adres zie je welke modules er zijn, welke endpoints bij elke module horen en of de module in je werkruimte aanstaat.
GET https://leadforge.nl/api/v1/modules
Vraagt read
Alle modules met hun endpoints en of ze aanstaan.
Parameters
Geen. Het antwoord heeft altijd dezelfde vijf modules.
Antwoord
Velden
| Naam | Type | Beschrijving |
|---|---|---|
| key | tekst | De vaste sleutel van de module. |
| label | tekst | De naam van de module. |
| status | tekst | live als de module beschikbaar is, planned als hij nog komt. |
| omschrijving | tekst | Korte uitleg in het Nederlands. Dit veld heeft een Nederlandse naam. |
| endpoints[].method | tekst | GET of POST. |
| endpoints[].path | tekst | Het pad na /api/v1, bijvoorbeeld /leads. |
| endpoints[].scope | tekst | Het recht dat het endpoint vraagt: read of write. |
| endpoints[].omschrijving | tekst | Korte uitleg van het endpoint. |
| enabled | boolean | true als de module live is en het bijbehorende product in je werkruimte aanstaat. |
Goed om te weten
enabled is alleen informatie. Het blokkeert geen aanroep: ook met enabled: false werken de endpoints van een live module met een geldige sleutel.De vijf modules
| key | label | status | Endpoints |
|---|---|---|---|
agent-page | Agent page | live | GET /agents, GET /conversations, GET /conversations/{id}, POST /conversations/{id}/reply |
content | Content en kennishiaten | live | GET /content-gaps |
leads | Leads en pipeline | live | GET /leads, GET /leads/{id}, GET /campaigns |
seo | SEO-agents | planned | Nog geen |
sea | SEA-agents | planned | Nog geen |
GET /api/v1/me en GET /api/v1/modules horen bij geen module en werken altijd met een geldige sleutel.
Voorbeeld
curl https://leadforge.nl/api/v1/modules \
-H "Authorization: Bearer LF_LIVE_SLEUTEL"
{
"data": [
{
"key": "content",
"label": "Content en kennishiaten",
"status": "live",
"omschrijving": "Vragen die je agent niet kon beantwoorden, met hoe vaak ze gesteld zijn. De directe voedingsbodem voor content- en SEO-werk.",
"endpoints": [
{
"method": "GET",
"path": "/content-gaps",
"scope": "read",
"omschrijving": "Onbeantwoorde vragen met frequentie en prioriteit"
}
],
"enabled": true
},
{
"key": "seo",
"label": "SEO-agents",
"status": "planned",
"omschrijving": "Zoekwoorden, posities en contentopdrachten van de SEO-agents. Komt vrij zodra de agents draaien.",
"endpoints": [],
"enabled": false
}
]
}
| Status | Code | Wanneer |
|---|---|---|
| 200 | De vijf modules. | |
| 401 | unauthorized | Geen geldige sleutel. |
| 403 | forbidden | De sleutel heeft geen read, of hoort niet bij één werkruimte. |
| 429 | rate_limited | Meer dan 120 verzoeken per minuut. |