Limits#
To ensure a positive experience for all, the Workiva API enforces a number of constraints.
Rate Limits#
The API may rate limit clients based on system load or excessive request frequency. When this
happens you will receive a 429 Too Many Requests response. Respect any Retry-After
response header when it is provided.
Page Size#
List endpoints accept $maxpagesize up to a maximum of 1000 items per page (the default
is 100). Requests above the maximum are clamped.
Batch Size#
Batch endpoints (POST /{resource}/batchRetrieval) accept up to 250 ids per request. Split
larger id sets into multiple requests. The exception is POST /issues/batchRetrieval, which
accepts up to 50 issue ids.
Remediation Limits#
An issue has at most 10 action tasks, and
GET /issues/{issueId}/actionTasksreturns them all in one page.An issue holds at most 5 controls, 5 processes, 5 risks, and 10 collaborators. A
PATCHthat would exceed one of these returns400.A workspace has at most 100 custom fields.
A JSON Patch on an issue accepts up to 100 operations, and on an action task up to 3.
POST /issues/exportallows one export in flight per caller per workspace, anupdatedAtwindow of at most 366 days (the default is 365), and at most 50,000 issues per export. Its effective window ends 30 seconds before the request. An export stays available for 7 days.
Payload Size#
Request payloads are limited to a maximum of 10485760 bytes (10 MB).
Timeouts#
Requests are limited to 29 seconds.