Skip to main content


All responses will have either a data or error field. A request for a collection of data will populate data with an array, otherwise data will be a single JSON object. If an error occurs - th error field will be populated with a message. Below is an illustration of the API response in TypeScript.

interface ApiResponse {
data?: any;
error?: string;