Rate Limiting
Note: The maximum rate limit is based on your subscription plan. We do not have any additional add-on options for rate limits outside the subscription plan.
429 Error Code
OK, we had to add in rate limiting to keep you guys from hammering our poor servers. The API rate limit is global so if there are multiple users making request at the same time, they will all count towards the total limit per minute. So if we receive more that 150 requests per minute, we will send you to the sin bin. ie. you will receive a HTTP 429 Error code in response. The status text returned will be "You have exceeded your rate limit. Please try again in a little while."
Each response will contain the following headers:
X-Rate-Limit-Limit
: The rate limit ceiling for this endpoint.X-Rate-Limit-Remaining
: The number of requests left for the time window.X-Rate-Limit-Reset
: The remaining window before the rate limit resets, in UTC epoch seconds.
After 60 seconds, we'll let you back in!
Everything up to and including the Grow Plan : 150 requests / minute
Scale Plan : 300 requests / minute
Note:
If you are syncing data and pulling paged data constantly you might find your rate limits reduced with a response header "Syncing data requires an updatedAfterDate
to be passed. Rate limit reduced...."
In this case you must pass in updatedAfterDate
. Note that when used, if the data set returned is too large it will limit the response to return changes that occured in the last 6 months.
Feedback
If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.