Référence APIChecklist d'onboarding
GET/v1/diagnostics/setup-checklist

Checklist d'onboarding

Renvoie un scorecard des tâches d'onboarding du workspace et leur statut.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"items": [
{
"key": "workspace_named",
"done": true,
"label": "Workspace nommé",
"impact": "low"
},
{
"key": "branding_logo",
"done": false,
"label": "Logo de marque téléchargé",
"impact": "medium"
},
{
"key": "mfa_enabled",
"done": true,
"label": "MFA activé",
"impact": "high"
},
{
"key": "first_transfer",
"done": true,
"label": "Premier transfert créé",
"impact": "high"
},
{
"key": "api_key",
"done": false,
"label": "Au moins 1 clé API",
"impact": "medium"
}
],
"score": 55
}

Évalue l'avancement de l'onboarding du workspace (nom, marque, domaines, MFA, webhooks, clés, membres) et renvoie un score global avec le statut de chaque tâche.

Authentification

Requiert une clé API valide (aucun scope spécifique).

Codes de statut

  • 200 Checklist renvoyée.