Intervals API Errors
The following is a list of error codes for the Intervals project management software API.
API Code | Details | HTTP Status Code |
---|---|---|
1 | General (unknown) error. | 500 |
2 | Customer account not found (possible bad subdomain | 401 |
3 | Customer account inactive | 401 |
4 | Customer account suspended | 503 |
5 | Customer account banned | 418 |
6 | Paid customer account inactive due to non-payment | 402 |
7 | User not found | 401 |
8 | User not active | 401 |
9 | Invalid auth (bad username/password) | 401 |
10 | Permissions error. User/Company does not have access to this information. | 403 |
11 | Maximum number of daily API requests exceeded | 400 |
12 | Requests too fast | 400 |
13 | Resource type requested does not exist (e.g. if you requested 'miletsone' instead of 'milestone'). | 400 |
14 | Resource requested does not exist (e.g. if you wanted task 25 and it doesn't exist) | 404 |
15 | Action not available for resource (e.g. if they wanted to perform task 'reopen'). | 400 |
16 | HTTP method not available (e.g. if you try to call DELETE client without the id). | 400 |
17 | Parameter not recognized (e.g. when they try to filter on 'statusid' when it's not possible). | 400 |
18 | Validation error (e.g. missing required field/parameter, or bad field/parameter). | 400 |
19 | Database Error (something went wrong on our end) | 500 |
20 | Service offline. (system down, try again later) | 502 |
HTTP Status Codes
Here are some general rules of thumb when considering the HTTP responses that are returned to you:
200 OK, 201 Created, 202 Accepted:
Everything went awesome.
400 Bad Request:
Your request is invalid and/or not formed properly. You need to reformulate your request.
401 Not Authorized:
Either you need to provide authentication credentials, or the credentials provided aren't valid.
403 Forbidden:
We understand your request, but are refusing to fulfill it. An accompanying error message should explain why.
404 Not Found:
Either you're requesting an invalid URI or the resource in question doesn't exist (ex: no such user).
500 Internal Server Error:
We did something wrong. We'll be notified and we'll look into it.
502 Bad Gateway:
Returned if Intervals is down or being upgraded, or if the system is overloaded and API requests are being throttled.
503 Service Unavailable:
Usually as a result of suspension, we are refusing to process this request. You *may* try again later.
Example Error Response
An example of an XML response:
<?xml version="1.0" encoding="UTF-8"?> <intervals status="Unauthorized" code="401"> <error> <code>6</code> <message>User bad auth</message> </error> </intervals>
An example of a JSON response:
{ "status":"Unauthorized", "code":401, "error":{ "code":6, "message":"User bad auth" } }
Note: These example responses have been formatted for easy viewing. The actual response returns with whitespace stripped.
As you can see, the output contains two separate error codes: one represents the HTTP code (this attribute is available in all responses whether good or bad), and the other the more precise Intervals API error code.
Intervals API
This documentation is meant to serve as an introduction to getting started with the API.
Documentation
Resources
- client
- contactdescriptor
- contacttype
- document
- expense
- group
- invoice
- invoiceitem
- invoicenote
- invoiceterm
- me
- milestone
- milestonenote
- module
- payment
- paymenttype
- person
- personcontact
- project
- projectlabel
- projectmodule
- projectnote
- projectteam
- projectworktype
- quota
- request
- task
- tasklistfilter
- tasknote
- taskpriority
- taskstatus
- time
- timer
- worktype
API Support
Looking for help?
» Contact our support team.