Skip to content

Document the workflow details rate limit #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wstrinz wants to merge 2 commits into from
+17 −0
Draft

Document the workflow details rate limit #139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d37cda7
Document the workflow details rate limit
wstrinz Oct 22, 2026
bec7e73
Tighten the workflow details rate limit wording
wstrinz Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions source/includes/rest/_workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,23 @@ The `ETag` describes this view of the workflow rather than the workflow's stored
is a cache validator only. Two workflows that differ solely in fields this endpoint withholds share
an `ETag`, and a change confined to a withheld field does not invalidate one.

### Rate limits

> If the rate limit is exceeded, responds with a <code>429 Too Many Requests</code> and a
> <code>Retry-After</code> header indicating when the limit resets:

```json
{
"errors": [{
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded: at most 2000 requests per account per hour."
}]
}
```

This endpoint has its own rate limit of 2,000 requests per account per hour, in addition to the
[general rate limit](#rate-limiting).

### HTTP Endpoint

`GET /v2/:account_id/workflows/:workflow_id/details`
Expand Down
Loading