Throughout these docs, properties marked as
NULLABLE may be dropped from the response.
The Truework API safeguards itself from bursts of incoming traffic by employing API limits on each endpoint. Users who send many requests in quick succession may begin to see 429 error responses from the API. We recommend an retrying requests using exponential backoff once receiving a 429 response.
There are two types of limit:
- IP Address: Limits that apply to the IP address that requests are coming from.
- Account: Limits that apply to the overall account.
|IP Address||10 requests per second|
|Account||10 requests per second|
If these limits do not fit your use case, please contact us.
The Truework API uses standard HTTP codes to specify whether the request succeeded or failed. Here is a summary of status codes that we return in our API:
|The request was successful.|
|The request provided missing or invalid data. An error response will be returned in JSON format containing an |
|The request's authorization is missing, invalid, or expired.|
|The requested resource does not exist.|
|An invalid API version was requested.|
|The request was not serviced because a rate limit has been exceeded.|
|The request could not be completed due to an internal server error. If this issue persists, please contact us at firstname.lastname@example.org|