Meta

In addition to the main resource root, the response may also contain a meta object. This object contains information about the response itself.

The meta object contains page key that is set to the current page number, limit key that is set to the number of objects returned per page, and total key that is set to the total number of objects returned by the request.

The meta object will only be displayed when it has a value. Currently, the meta object will have a value when a request is made on a collection (like students or classrooms).

Sample Meta Object

{
    "meta": {
        "page": 1,
        "limit": 20,
        "total": 43
    }
}

Sample Meta Object#

Sample Meta Object