API Documentation

Response Formats

In most cases, the API will return the response in JSON format.

JSON Response

The JSON response can contain a number of properties, but a success property will always be returned with either true or false. When data is expected, the data will always be returned in a data property.

{
	"data": [{...data here}],
	"success": true,
}

A response with an error will look something like this:

{
	"success": false,
	"errors": [
		"Description field is required"
	]
}

CSV

The response format can be set to CSV by setting the response query parameter to csv.

Human Readable Response

If the humanReadable query parameter is set and true, failed requests will return an HTML response with a human readable error message. For successful requests, JSON will still be returned.

Other Response Formats

In some cases, other response formats like PDF will be returned, according to the needs of that particular endpoint.