Meta

In addition to the main resource root, the response can also include meta-objects, which contain information related to the response itself.

The meta-object contains a total key that is set to the total number of objects returned by the request. This affects the linked objects and pagination as well.

Meta-object is displayed only if it has a value. In this case, when a request is made to a collection, it means the meta-object has a value in it.

Example

Simple Meta Object

{
    . . .
    "meta": {
        "total": 12
    }
    . . .
}