This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
Every request to our REST API is responded to with an HTTP status code. Where appropriate, more information is provided in the response body.
Listed below are the possible response codes you could be returned along with additional information as to their meaning.
|200||OK||Signifies that the operation (GET, POST, PUT) was dealt with successfully.|
|201||Created||Indicates that resource has been created successfully. The URL for the newly created resource is usually included in the Location header.|
|204||No Content||Similar to 200 in that it signifies that the operation was dealt with successfully. The difference is that there is no additional content to give you.|
This would usually be returned as a result of a DELETE request.
|400||Bad Request||The request you made was invalid. This could be for a number of reasons.|
You should examine the response body for more information as to why the request was invalid.
|401||Unauthorized||The request is unauthorized. This means the authentication details for the request are non-existent, invalid or have expired.|
Alternatively, the authentication details may be valid but you are trying to access a resource that the authenticated account is not permitted to access.
|404||Not Found||Indicates that the resource requested does not exist.|
|405||Method Not Supported||The method you attempted to use (GET, POST, PUT, DELETE) is not supported for the given URL.|
|500||Internal Server Error||Something went wrong on the server. This should never happen, but if it does then please contact support with full details of the request.|