agency-board

GET /v1/agency/boards/{boardId}/automations/{ruleId}

One rule.

Alle agency-board-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId}/automations/{ruleId} \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Parameters

NaamTypeVerplichtWat dit is
boardId (path)UuidJaProject board ID (UUIDv7).
ruleId (path)UuidJaAutomation rule ID (UUIDv7).

Reactie

NaamTypeVerplichtWat dit is
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringJa
descriptionstringNee
triggerstringJa
trigger_configobjectNee
conditionsBoardAutomationCondition[]Nee
actionsBoardAutomationAction[]Nee
statusBoardAutomationStatusJa`suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin…
positionintegerNee
run_countintegerNee
fired_countintegerNee
consecutive_failuresintegerNee
suspended_reasonstringNeeWhy we paused this rule, in authored copy from a closed table — never an exception, a status or a message from our own code. The per-failure detail lives on each run (`action_re…
suspended_atstringNee
last_fired_atstringNee
last_run_atstringNee
next_due_atstringNeeOnly set for a wall-clock rule. Null for a rule on a live act.
created_atstringNee
updated_atstringNee

Fouten die dit eindpunt kan retourneren

401 · 403 · 404