API Response Overview

Below are the typical elements of an API response:

• header - API header.

• meta - Meta data.

• data - Actual data contained in the model as name:value pairs.

• schema - Schema describing the structure of the data of the resource, in particular the data types of the names in the name:value pairs in the data.

• resources - An object grouping a list of single resource’s meta and data objects in an API list response

• pagination - an object containing pagination data in an API list response

Not all the elements above exist in each response. These differ depending on request parameters and whether response contains a list of resource or a single resource.