Référence APIRécupérer une règle d'automatisation
GET/v1/rules/{id}

Récupérer une règle d'automatisation

Retourne une règle d'automatisation unique de l'espace de travail à partir de son identifiant.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"id": "a3f1c8e2-7b94-4d51-9f2a-1c6e8d0b4f73",
"name": "Notifier Slack à chaque transfert créé",
"created_at": "2026-05-20T14:02:00.000Z",
"is_enabled": true,
"action_type": "slack_notify",
"description": "Envoie un message dans #transferts",
"workspace_id": "11111111-2222-3333-4444-555555555555",
"action_config": {
"webhook_url": "https://hooks.slack.com/services/T000/B000/XXXX"
},
"trigger_count": 47,
"trigger_event": "transfer.created",
"last_triggered_at": "2026-06-04T09:12:33.000Z",
"trigger_conditions": {
"min_files": 2,
"encryption_mode": "e2e"
}
}
GET/v1/rules/{id}Récupère une règle d'automatisation par son identifiant.

Retourne une règle d'automatisation unique appartenant à l'espace de travail authentifié. La règle est résolue à la fois par son id et par le workspace_id du jeton : une règle appartenant à un autre espace de travail renverra toujours 404, jamais le contenu. La réponse expose les compteurs d'exécution (trigger_count, last_triggered_at) utiles pour suivre l'activité d'une règle.

Authentification

Cette requête nécessite une clé API valide dont le jeton porte le scope transfers:manage. Un scope plus large (par exemple *) satisfait également l'exigence. En l'absence de ce scope, la requête est rejetée avec 403 scope_missing.

Paramètres de requête

ParamètreTypeEmplacementDescription
idstring (UUID)CheminIdentifiant de la règle à récupérer. Doit appartenir à l'espace de travail du jeton.

Réponse

Retourne l'objet règle complet. Champs clés : trigger_event (l'événement déclencheur), trigger_conditions (filtres optionnels appliqués au payload de l'événement, ou null), action_type et action_config (l'action exécutée et sa configuration), is_enabled (la règle ne s'exécute que si elle est active), ainsi que last_triggered_at et trigger_count pour le suivi d'activité.

ChampTypeDescription
idstringIdentifiant de la règle.
namestringNom de la règle.
descriptionstring | nullDescription libre.
trigger_eventstringÉvénement déclencheur (ex. transfer.created).
trigger_conditionsobject | nullFiltres optionnels sur le payload de l'événement.
action_typestringType d'action exécutée.
action_configobjectConfiguration de l'action.
is_enabledbooleanIndique si la règle est active.
last_triggered_atstring | nullDate du dernier déclenchement (ISO 8601).
trigger_countnumberNombre total de déclenchements.
created_atstringDate de création (ISO 8601).
workspace_idstringEspace de travail propriétaire.

Erreurs

CodeQuandRésolution
401 invalid_api_keyClé API absente, invalide, expirée ou révoquée.Vérifiez l'en-tête Authorization et la validité de la clé.
403 scope_missingLe jeton ne porte pas le scope transfers:manage.Générez une nouvelle clé incluant transfers:manage sur app.coffrify.com/developer.
404 not_foundAucune règle avec cet id dans l'espace de travail.Vérifiez l'identifiant et que la règle appartient bien à votre espace de travail.
429 rate_limitedQuota de requêtes de lecture dépassé pour l'espace de travail.Patientez selon l'en-tête Retry-After avant de réessayer.
500 internal_errorErreur interne lors de la lecture en base.Réessayez ; si le problème persiste, contactez le support avec le request_id.

Voir aussi