Fields

Each object has standard and mini formats, which both include a certain set of fields:

The standard format is returned when you request a specific object (e.g. GET /teams/{id}).
The mini format is returned when the object is part of a set of items (e.g. GET /teams/<id>/boards).

📘
The mini format for each object is shown at the bottom of the object's description.

When you send a request, it will return a set of fields by default. However, you can specify which fields you want to return by using the fields parameter and listing each field. This will override the defaults and return only the fields you specify. The id and type of the object is always returned.

For example, if you want to get the title and picture fields for a board, you can follow the format below:

{
    "type": "board",
    "name": "Marketing Research",
    "id": "o9J_k0jX1ps=",
    "owner": {
        "type": "user",
        "name": "Sergey",
        "id": "3074457345710988604"
    }
}

For those methods that return a collection, you can specify the fields that will be returned.

{
    "type": "list",
    "limit": 10,
    "offset": 0,
    "size": 3,
    "nextLink": null,
    "prevLink": null,
    "data": [
        {
            "type": "board",
            "name": "Marketing Research",
            "id": "o9J_k0jX1ps=",
            "owner": {
                "type": "user",
                "name": "Sergey",
                "id": "3074457345710988604"
            }
        },
        {
            "type": "board",
            "name": "My First Board",
            "id": "o9J_k0jX5wc=",
            "owner": {
                "type": "user",
                "name": "Sergey",
                "id": "3074457345710988604"
            }
        }
    ]
}

Nested fields

You can specify nested fields for JSON objects, listing them in curly braces. For example, to get the name of the board, as well as the name of its owner, you can make the following request:

{
    "type": "board",
    "name": "Marketing Research",
    "id": "o9J_k0jX1ps=",
    "owner": {
        "type": "user",
        "name": "Alex",
        "email": "[email protected]",
        "id": "3074457345710988604"
    }
}