Request, Response, Pagination, and Error formats

Supply'd's API exchanges data in JSON format, where:

1. all requests should include an Accept: application/json header

2. all responses will include a Content-Type: application/json header

POST/PUT requests expect JSON in the HTTP message body, and you must specify the Content-Type header in your request.

Pagination

If an API call requires pagination the response will include a link header for the next page of results:

Link: </v1/path/to/resource?page=X>; rel=next

The final page of results will not have a link header.

Errors

Depending on your request's Accept header, the error will be returned as plain-text or JSON.

Plain-text errors are just the message as a string.

JSON errors return the message, and may include the following format:

{
    "error": "<message>",
    "data": null|object
}