Skip to main content
L’API Retriever donne accès par programme à l’agent de prospection : vous envoyez une consigne, Retriever source, enrichit et qualifie des entreprises ou des contacts, puis vous lisez ou exportez la table produite.

Quickstart

Votre premier appel authentifié et une vraie liste d’entreprises en 5 minutes.

Référence API

Chaque endpoint, ses paramètres, ses réponses et ses erreurs.

Recettes

Enrichir une liste CRM, synchroniser des exclusions, gérer plusieurs clients.

Erreurs

Format standard, codes stables et actions à mener.

​
Base URL

​
Authentification

Chaque requête envoie une clé API dans l’en-tête Authorization :
  • Créez la clé dans l’application : Paramètres → Clés API → Créer une clé API. Elle n’est affichée qu’une fois.
  • La clé agit au nom de son créateur. Elle accède aux workspaces, tables et runs de son organisation. Les listes d’exclusion et les crédits sont ceux de l’utilisateur créateur.
Gardez la clé côté serveur. Ne la mettez jamais dans un navigateur, une application mobile ou un dépôt Git.

​
Ce que couvre l’API

​
Conventions

  • Les routes /v1/* sont versionnées. /services et /credits n’ont pas de préfixe /v1.
  • Les requêtes POST avec corps envoient Content-Type: application/json.
  • Les champs JSON sont en snake_case, sauf GET /credits (remainingCredits).
  • Les liens renvoyés dans links sont relatifs à la base URL et exigent la même clé.
  • Les messages d’erreur de l’API sont en anglais. Branchez votre code sur error.code, jamais sur message.