Contacts
Lister, lire, créer, modifier et supprimer des contacts via l'API. Champs renvoyés et corps de création.
French only for now
This page has not been translated yet. You are reading the French version.
La ressource contacts permet de gérer les personnes de votre annuaire. L'enveloppe (authentification, pagination, format des réponses) est identique aux autres ressources.
Endpoints
| Méthode | Chemin | Scope |
|---|---|---|
GET | /api/v1/contacts | read:contacts |
POST | /api/v1/contacts | write:contacts |
GET | /api/v1/contacts/{id} | read:contacts |
PATCH | /api/v1/contacts/{id} | write:contacts |
DELETE | /api/v1/contacts/{id} | write:contacts |
Lister les contacts
Paramètres de requête : limit, offset (voir Pagination) et q (recherche sur l'email et le nom).
Champs renvoyés
id, email, name, phone, createdAt, et company (objet { id, name }, ou null si le contact n'est rattaché à aucune entreprise).
Lire un contact
GET /api/v1/contacts/{id} renvoie les mêmes champs, avec un objet company enrichi : id, name, address, phone, siret, vatNumber, isSupplier.
Créer un contact
| Champ | Type | Requis | Notes |
|---|---|---|---|
name | texte, 1 à 200 caractères | Oui | |
email | email, 200 caractères max | Oui | Unique au sein de votre espace |
phone | texte, 32 caractères max | Non | |
companyId | texte | Non | Rattacher à une entreprise |
La réponse a le code 201 et contient le contact créé.
Exemple
curl -X POST "https://app.naskel.io/api/v1/contacts" \
-H "Authorization: Bearer nsk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": "Marie Durand", "email": "marie@acme.fr" }'
Le POST renvoie 409 contact_email_duplicate si l'email existe déjà, et 404 company_not_found si companyId est inconnu. Il accepte l'en-tête Idempotency-Key.
Modifier un contact
PATCH /api/v1/contacts/{id} met à jour un contact. Tous les champs sont optionnels : n'envoyez que ceux à changer.
| Champ | Type | Notes |
|---|---|---|
name | texte, 1 à 200 caractères | |
email | email, 200 caractères max | Reste unique dans votre espace |
phone | texte, 32 caractères max | |
companyId | texte | Rattacher à une entreprise |
Supprimer un contact
DELETE /api/v1/contacts/{id} supprime un contact. La suppression est douce (soft delete) : le contact quitte vos listes mais reste purgé définitivement au bout de 30 jours. Réponse : { "ok": true }.