Understanding Nested Resources

The Trello API provides a number of ways to access data throughout Trello. Because of the nested nature of the Trello experience (cards are in lists that are in boards), a number of resources are accessible as nested entities. Additionally, the API allows you to get at nested resources as URL parameters as well as query parameters.

For instance, if you wanted to get all of the cards for a board you could use: https://api.trello.com/1/boards/{boardId}/cards or https://api.trello.com/1/boards/{boardId}/?cards=all

Because a lot of the fields and values are duplicative, we've included a section of documentation for each resource that outlines how it can be accessed as a nested resource either via the URL or a query parameter.

A number of the parameters accept a comma-seperated list of fields for the given object. You should refer to the API reference or Object Defintion page for the given object to see details about each field.

Actions Nested Resource

Actions are often included as nested resources within the Trello API. Their highly-nested nature is due to the fact that actions are created within the context of other resources. For instance, when a user adds another user to a board, Trello creates an addMemberToBoard action that references the board. Therefore, it makes sense to be able to access all of the actions within the context of an object from which they were created.

Nested Actions with Query Params

Example Request

1
2
curl https://api.trello.com/1/boards/BdarzfKF/?fields=id&actions=addAttachmentToCard&actions_limit=2&action_fields=idMemberCreator&action_memberCreator_fields=fullName

And the result of the above request:

1
2
{
  "id": "54a17d76d4a5072e3931736b",
  "actions": [
    {
      "id": "54a1b7c3a6ea7c2b1eaa5cdf",
      "idMemberCreator": "53baf533e697a982248cd73f",
      "memberCreator": {
        "id": "53baf533e697a982248cd73f",
        "fullName": "Lauren Moon"
      }
    },
    {
      "id": "54a1b73f030916211e718516",
      "idMemberCreator": "53baf533e697a982248cd73f",
      "memberCreator": {
        "id": "53baf533e697a982248cd73f",
        "fullName": "Lauren Moon"
      }
    }
  ]
}

Nested Actions via URL Params

/object/{id}/actions

Example Request

1
2
curl https://trello.com/1/cards/NQNX2tzL/actions?fields=id,data&since=2022-04-22&memberCreator=false

Boards Nested Resource

Boards are accessible as nested resources via a number of other resources.

Nested Boards via Query Params

For objects that can contain multiple boards, like organizations and members

/1/{object}/{id}?boards=open

Cards Nested Resource

Cards are available as nested resources within many of the other Trello resources. Below are the parameters that are available to cards as nested resources.

Nested Cards as Query Params

Nested Cards as URL Params

Cards are also available as nested resources via URL parameters. For instance, you may want just the cards belonging to a specific resource like a list or a board; in that case you'd use the route /1/boards/{id}/cards with any of the options below as query parameters.

Example Request

Here's an example using the cards nested resource to get the visible cards in a list:

1
2
curl https://api.trello.com/1/lists/560bf44ea68b16bd0fc2a9a9/cards?fields=id,name,badges,labels

1
2
[
  {
    "id": "560bf4dd7139286471dc009c",
    "name": "Grand Canyon National Park",
    "badges": {
      "votes": 0,
      "viewingMemberVoted": false,
      "subscribed": false,
      "fogbugz": "",
      "checkItems": 0,
      "checkItemsChecked": 0,
      "comments": 0,
      "attachments": 2,
      "description": false,
      "due": null,
      "dueComplete": false
    },
    "labels": [
      {
        "id": "560bf42919ad3a5dc29f33c5",
        "idBoard": "560bf4298b3dda300c18d09c",
        "name": "Visited",
        "color": "green"
      }
    ]
  },
  {
    "id": "560bf4e25d93437b729482e0",
    "name": "Petrified Forest National Park",
    "badges": {
      "votes": 0,
      "viewingMemberVoted": false,
      "subscribed": false,
      "fogbugz": "",
      "checkItems": 0,
      "checkItemsChecked": 0,
      "comments": 0,
      "attachments": 1,
      "description": false,
      "due": null,
      "dueComplete": false
    },
    "labels": [

    ]
  },
  {
    "id": "560bf4e5ea91d2880f5dd840",
    "name": "Saguaro National Park",
    "badges": {
      "votes": 0,
      "viewingMemberVoted": false,
      "subscribed": false,
      "fogbugz": "",
      "checkItems": 0,
      "checkItemsChecked": 0,
      "comments": 0,
      "attachments": 1,
      "description": false,
      "due": null,
      "dueComplete": false
    },
    "labels": [
      {
        "id": "560bf42919ad3a5dc29f33c5",
        "idBoard": "560bf4298b3dda300c18d09c",
        "name": "Visited",
        "color": "green"
      }
    ]
  }
]

Checklists Nested Resource

Checklists are available as nested resources within many of the other Trello resources. Below are the parameters that are available to Checklists as nested resources.

Nested Checklists as Query Params

The table below shows query params available when accessing cards as a nested resource via query params. For instance, the query params are available when you are accessing cards via: /object/{id}?checklists=all.

Example Request

Here's an example using the checklists nested resource to get all of the checklists on a board:

1
2
curl https://api.trello.com/1/boards/v5sRYGdh/?fields=name&checklists=all

And the response:

1
2
{
  "id": "544a947a60022d7de4d28187",
  "name": "Connor's 8th Birthday Bash",
  "checklists": [
    {
      "id": "544a947b60022d7de4d281f1",
      "name": "Chores",
      "idBoard": "544a947a60022d7de4d28187",
      "idCard": "544a947b60022d7de4d281aa",
      "pos": 16384,
      "checkItems": [
        {
          "idChecklist": "544a947b60022d7de4d281f1",
          "state": "incomplete",
          "id": "544a947b60022d7de4d281f2",
          "name": "Vacuum carpet",
          "nameData": null,
          "pos": 16683,
          "due": null,
          "dueReminder": null,
          "idMember": null
        },
        {
          "idChecklist": "544a947b60022d7de4d281f1",
          "state": "incomplete",
          "id": "544a947b60022d7de4d281f3",
          "name": "Clean stove",
          "nameData": null,
          "pos": 33312,
          "due": null,
          "dueReminder": null,
          "idMember": null
        },
        {
          "idChecklist": "544a947b60022d7de4d281f1",
          "state": "incomplete",
          "id": "544a947b60022d7de4d281f4",
          "name": "Arrange coat closet",
          "nameData": null,
          "pos": 50543,
          "due": null,
          "dueReminder": null,
          "idMember": null
        },
        {
          "idChecklist": "544a947b60022d7de4d281f1",
          "state": "incomplete",
          "id": "544a947b60022d7de4d281f5",
          "name": "Clean out fridge",
          "nameData": null,
          "pos": 67424,
          "due": "2022-11-26T02:00:00.000Z",
          "dueReminder": -1,
          "idMember": "544a947b60022d7de4d281f6"
        }
      ]
    }
  ]
}

Nested Checklists as URL Params

Checklists are also available as nested resources via URL parameters. For instance, you may want just the Checklists belonging to a specific resource like a list or a card; in that case you'd use the route /1/cards/{id}/checklists with any of the options below as query parameters.

Example Request

Here's an example using the checklists nested resource to get all of the checklists on a board:

1
2
curl https://api.trello.com/1/boards/v5sRYGdh/checklists?fields=all

And the response:

1
2
[
  {
    "id": "544a947b60022d7de4d281f1",
    "name": "Chores",
    "idBoard": "544a947a60022d7de4d28187",
    "idCard": "544a947b60022d7de4d281aa",
    "pos": 16384,
    "limits": {
      "checkItems": {
        "perChecklist": {
          "status": "ok",
          "disableAt": 200,
          "warnAt": 180
        }
      }
    },
    "creationMethod": null,
    "checkItems": [
      {
        "idChecklist": "544a947b60022d7de4d281f1",
        "state": "incomplete",
        "id": "544a947b60022d7de4d281f2",
        "name": "Vacuum carpet",
        "nameData": null,
        "pos": 16683,
        "due": null,
        "dueReminder": null,
        "idMember": null
      },
      {
        "idChecklist": "544a947b60022d7de4d281f1",
        "state": "incomplete",
        "id": "544a947b60022d7de4d281f3",
        "name": "Clean stove",
        "nameData": null,
        "pos": 33312,
        "due": null,
        "dueReminder": null,
        "idMember": null
      },
      {
        "idChecklist": "544a947b60022d7de4d281f1",
        "state": "incomplete",
        "id": "544a947b60022d7de4d281f4",
        "name": "Arrange coat closet",
        "nameData": null,
        "pos": 50543,
        "due": "2022-11-26T02:00:00.000Z",
        "dueReminder": -1,
        "idMember": "544a947b60022d7de4d281f6"
      },
      {
        "idChecklist": "544a947b60022d7de4d281f1",
        "state": "incomplete",
        "id": "544a947b60022d7de4d281f5",
        "name": "Clean out fridge",
        "nameData": null,
        "pos": 67424,
        "due": null,
        "dueReminder": null,
        "idMember": null
      }
    ]
  }
]

Custom Fields Nested Resource

Custom fields can be included as a nested resource. The only parameter is whether to include the custom fields.

Labels Nested Resource

Labels are often included as a nested resource in Trello. Below you will find parameters available when working with labels as nested resources.

Nested Labels as Query Params

Example Request

1
2
curl https://api.trello.com/1/boards/kpPww9qv/?labels=all&label_fields=color&labels_limit=2&fields=id

And the response:

1
2
{
  "id": "543efd0c05d2a3ebc06a6534",
  "labels": [
    {
      "id": "546689ef74d650d567ffdd87",
      "color": "green"
    },
    {
      "id": "546689ef74d650d567ffdd8a",
      "color": "purple"
    }
  ]
}

Nested Labels as URL Params

Example Request

1
2
https://api.trello.com/1/boards/kpPww9qv/labels/?fields=color&limit=2

And the response:

1
2
[
  {
    "id": "546689ef74d650d567ffdd87",
    "color": "green"
  },
  {
    "id": "546689ef74d650d567ffdd8a",
    "color": "purple"
  }
]

Lists Nested Resource

Lists are available as nested resources within many of the other Trello resources. Below are the parameters that are available to lists as nested resources.

Nested Lists as Query Params

The table below shows query params available when accessing lists as a nested resource via query params. For instance, the query params are available when you are accessing lists via: /object/{id}?lists=open.

Example Request

Here is an example of using the lists nested resource on the boards endpoint:

1
2
curl https://api.trello.com/1/boards/k7hfpqQm/?fields=name&lists=all&list_fields=all

And the response:

1
2
{
  "id": "5ac61a2e05fae550b0d45c93",
  "name": "VR Education Academic Paper Tracker",
  "lists": [
    {
      "id": "5ac61a2e05fae550b0d45c94",
      "name": "Prompts",
      "closed": false,
      "idBoard": "5ac61a2e05fae550b0d45c93",
      "pos": 98303,
      "subscribed": false,
      "limits": {
        "cards": {
          "openPerList": {
            "status": "ok",
            "disableAt": 5000,
            "warnAt": 4500
          },
          "totalPerList": {
            "status": "ok",
            "disableAt": 1000000,
            "warnAt": 900000
          }
        }
      },
      "creationMethod": null
    }
  ]
}

Nested Lists as URL Params

Lists are also available as nested resources via URL parameters. For instance, you may want just the lists belonging to a specific resource like a board; in that case you'd use the route /1/boards/{id}/lists with any of the options below as query parameters.

Example Request

Here is an example of using the lists nested resource on the boards endpoint:

1
2
curl https://api.trello.com/1/boards/k7hfpqQm/lists?fields=all&filter=all

And the response:

1
2
[
  {
    "id": "5ac61a2e05fae550b0d45c94",
    "name": "Prompts",
    "closed": false,
    "idBoard": "5ac61a2e05fae550b0d45c93",
    "pos": 98303,
    "subscribed": null,
    "limits": {
      "cards": {
        "openPerList": {
          "status": "ok",
          "disableAt": 5000,
          "warnAt": 4500
        },
        "totalPerList": {
          "status": "ok",
          "disableAt": 1000000,
          "warnAt": 900000
        }
      }
    },
    "creationMethod": null
  }
]

Members Nested Resource

Members are available as nested resources within many of the other Trello resources. Below are the parameters that are available to members as nested resources.

Nested Members as Query Params

The table below shows query params available when accessing members as a nested resource via query params. For instance, the query params are available when you are accessing boards via: /1/boards/{id}?members=all.

Nested Members as URL Params

Members are also available as nested resources via URL parameters. For instance, you may want just the members belonging to a specific board; in that case you'd use the route /1/boards/{id}/members with any of the options below as query parameters.

Notifications Nested Resource

Notifications as Query Params

/object/{id}?notifications=all...

Reactions Nested Resource

Reactions are often included as nested resources within the Trello API. Their highly-nested nature is due to the fact that reactions are created within the context of actions.

For instance, when a user reacts to a comment on a card, Trello creates a reaction that references the action. Therefore, it makes sense to be able to access all of the reactions within the context of the action on which they were created.

Nested Reactions with Query Params

Example Request

1
2
curl --request GET \
  --url https://api.trello.com/1/actions/id?reactions=true

And the response:

1
2
{
  "id": "5afc2c98bb0aa3d078e30be4",
  "reactions": [
    {
      "id": "5afeec8fb0850e36938e465b",
      "idMember": "54f8181e733cf3c45ec056be",
      "idModel": "5afc2c98bb0aa3d078e30be4",
      "idEmoji": "1F64C",
      "member": {
        "id": "54f8181e733cf3c45ec056be",
        "avatarHash": "0fdb1227362c631f7dddaebedbe13f07",
        "avatarUrl": "https://trello-avatars.s3.amazonaws.com/0fdb1227362c631f7dddaebedbe13f07",
        "fullName": "Felix Haehnel",
        "initials": "FH",
        "username": "fhaehnel"
      },
      "emoji": {
        "unified": "1F64C",
        "native": "🙌",
        "name": "PERSON RAISING BOTH HANDS IN CELEBRATION",
        "skinVariation": null,
        "shortName": "raised_hands"
      }
    }
  ]
}

1
2
curl --request GET \
  --url https://api.trello.com/1/cards/id?actions=commentCard&action_reactions=true

1
2
{
  "id": "5a2ee8e4c0fddff47c596129",
  "actions": [
    {
      "id": "5afc2c98bb0aa3d078e30be4",
      "reactions": [
        {
          "id": "5afeec8fb0850e36938e465b",
          "idMember": "54f8181e733cf3c45ec056be",
          "idModel": "5afc2c98bb0aa3d078e30be4",
          "idEmoji": "1F64C",
          "member": {
            "id": "54f8181e733cf3c45ec056be",
            "avatarHash": "0fdb1227362c631f7dddaebedbe13f07",
            "avatarUrl": "https://trello-avatars.s3.amazonaws.com/0fdb1227362c631f7dddaebedbe13f07",
            "fullName": "Felix Haehnel",
            "initials": "FH",
            "username": "fhaehnel"
          },
          "emoji": {
            "unified": "1F64C",
            "native": "🙌",
            "name": "PERSON RAISING BOTH HANDS IN CELEBRATION",
            "skinVariation": null,
            "shortName": "raised_hands"
          }
        }
      ]
    }
  ]
}