agency-board
GET /v1/agency/boards/{boardId}/automations/{ruleId}/runs
Every time this rule was considered — and why it did or did not fire.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId}/automations/{ruleId}/runs \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
A row is written whenever the rule was **considered**, not only when it fired, and each carries the result of every condition with the value it actually saw. ⛔ That is the whole point of the endpoint. A rule that does not fire otherwise leaves the customer with an absence, which is indistinguishable from "the trigger never happened", from "it is disabled" and from "the platform is down".
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
ruleId (path) | Uuid | Yes | Automation rule ID (UUIDv7). |
limit (query) | integer | No | Maximum items to return (page size). |
cursor (query) | string | No | Opaque cursor from a previous page's `page.next_cursor`. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | BoardAutomationRun[] | Yes | — |
page | PageMeta | Yes | — |
Errors this endpoint can return
401 · 403 · 404