API publique v1

URL de base

https://api.volia.fr/v1

Authentication

Toutes les requêtes nécessitent un header :

Authorization: Bearer YOUR_API_KEY

Génère ta clé API dans Paramètres → API & intégrations. Cf. Clés API & sécurité.

Rate limits

60 requêtes / minute par clé API (Gratuit).
300 requêtes / minute (Prospection).
1500 requêtes / minute (MAX).

Si dépassé : HTTP 429 + header Retry-After.

Endpoints principaux

Prospects

GET    /v1/prospects                      Liste paginated
GET    /v1/prospects/:id                  Détail
POST   /v1/prospects                      Créer (manuel)
PATCH  /v1/prospects/:id                  Update
DELETE /v1/prospects/:id                  Delete
POST   /v1/prospects/search               Lancer une recherche (async, retourne job_id)
GET    /v1/prospects/search/:job_id       Statut d'une recherche

Campagnes

GET    /v1/campaigns                      Liste
POST   /v1/campaigns                      Créer
PATCH  /v1/campaigns/:id                  Update
POST   /v1/campaigns/:id/launch           Lancer
POST   /v1/campaigns/:id/pause            Pause
GET    /v1/campaigns/:id/stats            Stats

CRM

GET    /v1/deals                          Liste deals
POST   /v1/deals                          Créer
PATCH  /v1/deals/:id                      Update (changer étape, valeur…)
GET    /v1/contacts/:id                   Détail contact
GET    /v1/pipelines                      Liste pipelines + étapes

Exemple — Lister mes 50 derniers prospects

curl -H "Authorization: Bearer sk_live_xxx" \
  https://api.volia.fr/v1/prospects?limit=50&order=desc

Exemple — Créer un deal

curl -X POST https://api.volia.fr/v1/deals \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Garage Dupont — site web",
    "value": 5000,
    "contact_id": "ctc_abc123",
    "pipeline_id": "pip_default",
    "stage": "Qualifié"
  }'

Format réponse

JSON uniquement. Pagination cursor-based (next_cursor).

{
  "data": [ { ... }, { ... } ],
  "next_cursor": "eyJpZCI6...",
  "has_more": true
}

FAQ rapide

Doc OpenAPI (Swagger) ? Disponible sur api.volia.fr/v1/openapi.json.

SDK officiel ? Pas encore — Node SDK prévu Q3 2026.

Webhooks sortants ? Oui, cf. Webhooks.