Introduction
This TimeWorksPlus API explorer is retained for internal and legacy integrations. It is not the supported starting point for new third-party integrations.
New third-party integrations should use the current WorkforceHub API. Start with the WorkforceHub API overview and the current WorkforceHub API reference.
The legacy API is organized around REST. It has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors.
Authentication
Errors
TimeWorksPlus API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (for example, a required parameter was omitted), and codes in the 5xx range indicate an error with TimeWorksPlus API servers (these are rare).
Not all errors map cleanly onto HTTP response codes. When a request is valid but does not complete successfully, we return a 402 error code.
- 200 - OK. Everything worked as expected.
- 201 - Created. A new resource has been created.
- 401 - Unauthorized. No valid API token provided.
- 404 - Not Found. The requested resource does not exist.
- 406 - Not Acceptable. The parameters were valid but the request failed.
- 409 - Conflict. Unable to process the request due to a conflict.
- 429 - Too Many Requests. Too many requests hit the API too quickly.
- 500, 502, 503, 504 - Server Errors. Something went wrong on TimeWorksPlus's end. These are rare.