Entreprises
Lister, lire, créer et modifier des entreprises via l'API. Ces endpoints réutilisent les scopes des contacts.
French only for now
This page has not been translated yet. You are reading the French version.
La ressource companies permet de lister vos entreprises, d'en lire une, et d'en créer de nouvelles.
Scopes des contacts
Il n'existe pas de scope propre aux entreprises. Ces endpoints utilisent les scopes des contacts : read:contacts pour lire, write:contacts pour écrire.
Endpoints
| Méthode | Chemin | Scope |
|---|---|---|
GET | /api/v1/companies | read:contacts |
POST | /api/v1/companies | write:contacts |
GET | /api/v1/companies/{id} | read:contacts |
PATCH | /api/v1/companies/{id} | write:contacts |
Lister les entreprises
Paramètres de requête : limit, offset (voir Pagination) et q.
Le paramètre q recherche sur le nom et le SIRET, sans tenir compte de la casse.
Champs renvoyés
id, name, siret, vatNumber, address, phone, isSupplier, createdAt.
Créer une entreprise
| Champ | Type | Requis |
|---|---|---|
name | texte, 1 à 200 caractères | Oui |
siret | texte, 32 caractères max | Non |
vatNumber | texte, 32 caractères max | Non |
address | texte, 1000 caractères max | Non |
La réponse a le code 201 et contient l'entreprise créée.
Exemple
curl -X POST "https://app.naskel.io/api/v1/companies" \
-H "Authorization: Bearer nsk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": "ACME SARL", "siret": "12345678900012" }'
Lire une entreprise
GET /api/v1/companies/{id} renvoie les mêmes champs que la liste, plus la liste contacts[] ({ id, name, email }) des personnes rattachées à l'entreprise.
Modifier une entreprise
PATCH /api/v1/companies/{id} met à jour une entreprise. Tous les champs sont optionnels : n'envoyez que ceux à changer.
| Champ | Type | Notes |
|---|---|---|
name | texte, 1 à 200 caractères | |
siret | texte, 32 caractères max | |
vatNumber | texte, 32 caractères max | |
address | texte, 1000 caractères max | |
phone | texte, 32 caractères max | Accepté seulement au PATCH (pas au POST), mais toujours renvoyé |
Il n'existe pas de DELETE sur les entreprises.