API referencellms.txt
Overview
REST, JSON and bearer keys. Amounts are in cents, dates in ISO 8601.
https://api.workmade.com/v1
Errors
Errors return an HTTP status and an error object with a code you can switch on and a message you can show.
{
"error": {
"code": "insufficient_set_aside",
"message": "Saved $2,100.00 of $2,980.00. Add $880.00 before Jan 12.",
"param": null
}
}| Status | code | Means |
|---|---|---|
| 400 | invalid_request | A field is missing or wrong. param says which. |
| 401 | authentication_failed | The key is missing, deleted or for the other environment. |
| 404 | not_found | No object with that ID. |
| 409 | idempotency_conflict | Same idempotency key, different request. |
| 422 | insufficient_set_aside | Not enough saved to pay this quarter. |
| 422 | verification_required | The taxpayer hasn’t passed checks yet. |
| 429 | rate_limited | Too many requests. Wait for Retry-After seconds. |
| 500 | api_error | Our fault. Safe to retry with the same idempotency key. |
Pagination
List endpoints return up to limit items (default 20, max 100) and has_more. Pass the last ID as starting_after for the next page.
Rate limits
100 requests a second in live and 25 in sandbox. Every response carries RateLimit-Remaining and RateLimit-Reset headers.
Was this page helpful?