General API guidelines
HTTP response codes
Response codes will always be one of the following:
- 200 means success!
- 400 means an issue with the input data. Perhaps it was not formatted correctly, or referenced an invalid object, or failed certain validation done on our side.
- 401 means authentication failure. Either no credentials were supplied, or they were formatted incorrectly, or the credentials were invalid.
- 404 means the endpoint path is incorrect. Perhaps there was a typo in the path, or if the path involves a UUID, you may have formatted a UUID incorrectly.
- 405 means invalid HTTP method.
- 500 means an unexpected server error occurred. These are rare, and our team will immediately be notified and begin investigating the issue. You can expect an error response as described below.
We do NOT return 201s, 403s, or other common HTTP response codes. If you receive an unexpected HTTP response code, report it to our team.