Automatisation de l’annuaire

Votre premier appel à l’API Synthact

Lisez les contacts de votre organisation avec un exemple de requête et sa réponse. La documentation complète est accessible dans le portail.



Lire les contacts de votre organisation

Dans le portail, ouvrez API, activez l’accès et créez une clé avec la permission contacts:read. Une clé peut uniquement accéder à l’organisation à laquelle elle appartient.

Voici un appel de lecture. Remplacez VOTRE_CLE_API par votre clé, conservée dans votre environnement sécurisé.

curl --request GET \
  --url 'https://synthact.fr/api/v1/organization/contacts/?page=1&page_size=1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer VOTRE_CLE_API'

Comprendre la réponse

Exemple fictif pour un annuaire contenant un seul contact, avec la permission contacts:read :

{
  "results": [{
    "id": "00000000-0000-4000-8000-000000000001",
    "external_id": "crm-camille",
    "given_name": "Camille",
    "family_name": "Martin",
    "company": "Entreprise fictive",
    "job_title": "Responsable d’agence",
    "department": "Agence Lyon",
    "mobile_phone": "",
    "mobile_phone_normalized": "",
    "work_phone": "",
    "work_phone_normalized": "",
    "email": "camille.martin@example.test",
    "version": 1,
    "updated_revision": 1,
    "created_at": "2026-09-13T10:00:00Z",
    "updated_at": "2026-09-13T10:00:00Z"
  }],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": false
  }
}

results contient les contacts de la page. Si has_next vaut true, demandez la page suivante. Vous pouvez lire jusqu’à 100 contacts par page. Les identifiants de groupes sont ajoutés avec la permission groups:read.

Passer à votre intégration

Le portail documente aussi les créations, modifications, suppressions et affectations aux groupes. Les écritures nécessitent leurs permissions propres ; une création par POST utilise également un en-tête Idempotency-Key.

Ouvrir la documentation API du portail

Connexion administrateur requise. Vous y trouverez les champs acceptés, les filtres, les exemples d’écriture, les erreurs et les limites de requêtes.

Questions fréquentes

Questions sur l’API d’annuaire Synthact

Quelles données l’API d’organisation permet-elle de gérer ?

Selon les permissions de la clé, l’API permet de lire ou gérer les contacts et les groupes de l’organisation, ainsi que l’affectation des contacts à ces groupes.

L’API est-elle activée automatiquement ?

Non. Elle est désactivée par défaut. Un administrateur de l’organisation doit l’activer et accepter l’avertissement de sécurité avant de pouvoir créer une clé.

Peut-on limiter une clé à la lecture ?

Oui. Les permissions de lecture et d’écriture sont séparées pour les contacts et les groupes. Une clé ne doit recevoir que les droits nécessaires à son intégration.

Que faire si une clé semble compromise ?

Révoquez-la immédiatement depuis le portail et avertissez Synthact si l’incident peut affecter la plateforme. Une rotation permet aussi de remplacer une clé active dans un cadre planifié.

Relier l’automatisation à la distribution Android

Les contacts et groupes entretenus par l’API suivent les mêmes règles de distribution que ceux gérés depuis le portail.