Aller au contenu
Organisation et réglages/Lister les entités

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èreValeur
AdresseGET /api/v1/entities
Par son nomPOST /api/v1/tools/list_entities, la réponse sous data
Nom de l'outillist_entities
Droit demandéLire les totaux (vue CEO, vue groupe, payback) (aggregates.read)
Rôles qui ont ce droit par défautPropriétaire, CMO, Marketing Ops, VP Sales, Responsable de programme, DAF, CEO, Lecteur / auditeur
Par MCPOui, 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.