Rate limits

Limits are counted per minute. A request over a limit gets a 429 with a Retry-After header.

The limits

Limits are counted per minute. Each counter starts with the first request it counts and resets 60 seconds later. Every request is counted against all the limits that apply to it:

LimitDefaultApplies to
Per keyOrganization key 120, user key 60, platform key 300 requests per minuteEach key on its own. A key can have its own limit instead, between 1 and 100,000 requests per minute. That limit replaces the tier default.
Per organization600 requests per minuteAll keys of one organization together. Creating more keys does not raise it.
Exports and reports6 requests per minuteThe routes listed below. One counter per key covers all of them.

These are the default values in Fido's configuration. Fido can set different values for an environment, so read the response headers rather than hard-coding a number. Responses that reach an endpoint carry these headers, and so does a 429:

  • X-RateLimit-Limit: the per-key limit for this key. On a 429, it is the limit that was exceeded.
  • X-RateLimit-Remaining: requests left in the current window for that limit.

When you get a 429

The response has HTTP status 429, code set to RATE_LIMITED, and a Retry-After header with the number of seconds to wait.

HTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 42
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 0
Content-Type: application/json

{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 42 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}

The message names which limit you hit: "this API key", "your organization", or "this endpoint" (the exports and reports limit). Wait for the number of seconds in Retry-After, then retry. If you keep hitting the limit, slow your requests down instead of retrying at once.

Routes with the exports and reports limit

These 30 operations share the lower limit. Each is marked in the reference.

Show all 30 routes
MethodPathSummary
GET/v1/assignment-export/{id}Export Single or Multiple Assignments to Excel
GET/v1/assignment/exportExport All Assignments to Excel
GET/v1/block-list-exportExport block list to Excel
GET/v1/clients/exportExport clients to Excel
GET/v1/consumers/exportExport all Consumers to Excel
GET/v1/export-client/{client}Export a Client to Excel
GET/v1/export-consumer/{consumer}Export a Consumer to Excel
GET/v1/export-location/{id}Export organization Location to Excel
GET/v1/export-scheduler/{scheduler}Export a single scheduler to Excel
GET/v1/finance/export/invoicesExport invoices
GET/v1/finance/export/payablesExport payables
GET/v1/finance/export/payment-statementsExport payment statements
GET/v1/finance/export/pro-formasExport pro formas
GET/v1/locations/exportExport locations to Excel
GET/v1/organization-locations/exportExport organization Locations to Excel
GET/v1/preference-list-exportExport preference list to Excel
GET/v1/provider/exportExport service providers to Excel
GET/v1/provider/single/export/{id}Export a Service Provider to Excel
GET/v1/scheduler/exportExport schedulers to Excel
GET/v1/settings/portal/block-list-exportExport block list to Excel
GET/v1/settings/portal/client/export-consumer/{consumer}Export a Consumer in client portal to Excel
GET/v1/settings/portal/client/export-consumersExport all Consumers in client portal to Excel
GET/v1/settings/portal/client/export-locationsExport locations to CSV in client portal
GET/v1/settings/portal/client/requests/exportExport All Requests to CSV
GET/v1/settings/portal/client/requests/export/{id}Export a Single Request to CSV
GET/v1/settings/portal/consumer/requests/exportExport All Requests to CSV
GET/v1/settings/portal/consumer/requests/export/{id}Export a Single Request to CSV
GET/v1/settings/portal/preference-list-exportExport preference list to Excel
GET/v1/shift-export/{id}Export a Single Shift to Excel
GET/v1/shift/exportExport All Shifts to Excel