Envelope Formats

Single Entity Response

Single entities do not have an envelope and are returned as a single object.

HTTP GET /resources/res_live_1
Authorisation: Bearer {token}

Response: 200 OK
{
    "id": "res_live_1",
    "name": "Resource 1"

{
    "id": "res_live_1",
    "name": "Resource 1"
}

Collection Responses

Collections are returned as an array of objects, with the following metadata:

data: This key contains the primary data payload of the response. For a collection, the data key holds an array of objects, each representing a resource in the collection.

meta: An optional key that may contain metadata about the collection, such as pagination details, counts, or any other supplementary information.

HTTP GET /resources
Authorisation: Bearer {token}

{
    "data": [
        {
            "id": "res_live_1",
            "name": "Resource 1"
        },
        {
            "id": "res_live_2",
            "name": "Resource 2"
        },
        // Additional resources in the collection
    ],
    "meta": {
        "total": 10,
        "page": 1,
        "per_page": 50
    }
}