Lister les entités
Liste les entités de l'organisation.
Une entité est la société dont le budget est piloté. Son identifiant sert à tous les envois faits pour une entité.
Appel
| Repère | Valeur |
|---|---|
| Adresse | GET /api/v1/entities |
| Par son nom | POST /api/v1/tools/list_entities, la réponse sous data |
| Nom de l'outil | list_entities |
| Droit demandé | Lire les totaux (vue CEO, vue groupe, payback) (aggregates.read) |
| Rôles qui ont ce droit par défaut | Propriétaire, CMO, Marketing Ops, VP Sales, Responsable de programme, DAF, CEO, Lecteur / auditeur |
| Par MCP | Oui, en lecture. |
Paramètres
Aucun paramètre.
Exemple
curl "$MARVESTO_URL/api/v1/entities" \
-H "x-api-key: $MARVESTO_API_KEY"Réponse
entities : pour chacune, entityId, name, siren, fiscalYearStartMonth (1 pour janvier), currency, hasBooks (sa comptabilité a été importée) et calendarLocked (pourquoi son exercice ne change plus, ou null).
Refus
Un refus répond { "message": "…" }, en français, avec son statut HTTP : voir Droits et erreurs.