Documentation API

Integrez Convertly dans vos outils avec notre API REST

Authentification

Toutes les requetes a l'API Convertly doivent inclure votre cle API dans le header Authorization. Vous pouvez generer et gerer vos cles API depuis vos parametres API.

Authorization: Bearer YOUR_API_KEY

Toutes les requetes doivent etre envoyees en HTTPS. Les requetes HTTP non chiffrees seront rejetees. Les cles API sont liees a votre compte et heritent de ses permissions.

Endpoints

Base URL : https://api.convertly.io

GET/api/v1/leads

Recupere la liste de vos leads avec pagination et filtres optionnels.

Requete

curl -X GET https://api.convertly.io/api/v1/leads \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Reponse

{
  "data": [
    {
      "id": "lead_abc123",
      "name": "Jean Dupont",
      "email": "jean@example.com",
      "score": 85,
      "status": "qualified",
      "source": "instagram",
      "createdAt": "2026-03-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 142
  }
}

POST/api/v1/leads

Cree un nouveau lead dans votre compte Convertly.

Requete

curl -X POST https://api.convertly.io/api/v1/leads \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marie Martin",
    "email": "marie@example.com",
    "source": "website",
    "tags": ["prospect", "high-ticket"]
  }'

Reponse

{
  "data": {
    "id": "lead_def456",
    "name": "Marie Martin",
    "email": "marie@example.com",
    "score": 0,
    "status": "new",
    "source": "website",
    "tags": ["prospect", "high-ticket"],
    "createdAt": "2026-04-07T14:22:00Z"
  }
}

GET/api/v1/conversations

Liste les conversations avec pagination. Filtrez par lead, canal ou statut.

Requete

curl -X GET https://api.convertly.io/api/v1/conversations?status=active \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Reponse

{
  "data": [
    {
      "id": "conv_xyz789",
      "leadId": "lead_abc123",
      "channel": "instagram",
      "status": "active",
      "lastMessageAt": "2026-04-07T09:15:00Z",
      "messageCount": 12
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 58
  }
}

POST/api/v1/conversations

Envoie un message dans une conversation existante ou en cree une nouvelle.

Requete

curl -X POST https://api.convertly.io/api/v1/conversations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leadId": "lead_abc123",
    "channel": "instagram",
    "message": "Salut ! Tu veux qu on planifie un call cette semaine ?"
  }'

Reponse

{
  "data": {
    "id": "conv_xyz789",
    "leadId": "lead_abc123",
    "channel": "instagram",
    "status": "active",
    "message": {
      "id": "msg_001",
      "content": "Salut ! Tu veux qu on planifie un call cette semaine ?",
      "sender": "bot",
      "sentAt": "2026-04-07T14:30:00Z"
    }
  }
}

Limites de debit

L'API Convertly applique des limites de debit pour garantir la stabilite du service.

Plan	Requetes/min	Requetes/jour
Scale	60	10 000
Enterprise	300	Illimite

En cas de depassement, l'API retourne un statut 429 Too Many Requests avec un header Retry-After indiquant le nombre de secondes a attendre.

Pret a integrer Convertly ?

Generez votre cle API depuis vos parametres et commencez a integrer en quelques minutes.

Gerer mes cles API