Trello Developers

Suggest Edits

Introduction

 

Welcome to Trello's REST API ๐Ÿ‘‹

We're glad you're here, and we hope you'll find the documentation helpful.

At Trello we do our best to build on top of the same public API that we document here. What does that mean for you? It means, that if you see something happening in the website, or in one of the apps, you can probably do that same thing via the API. It also means that if you venture into the network tab in your browser when using Trello, in general, you can make those same API requests from your integration. ๐Ÿ‘

You can use all of the routes we've documented inside of our docs! Before you get started you'll need to grab your API key ๐Ÿ— and generate a token. You can grab those here.

So what are you waiting for; let's get started building something awesome! ๐Ÿš€

p.s.
Spot a mistake, or something that could be better? Please use the ๐Ÿ“ Suggest Edits button.

Suggest Edits

API Key & Tokens

 

When making any API request to Trello, you will need to include your API key, along with an oauth token that was generated using your key.

So for example if you wanted to load the board with the id 560bf4298b3dda300c18d09c the full request would look like:

https://api.trello.com/1/boards/560bf4298b3dda300c18d09c?fields=name,url&key={YOUR-API-KEY}&token={AN-OAUTH-TOKEN}

API keys are associated with your Trello member account. We recommend when making Trello integrations that you create a new Trello account (don't worry, they are free) specifically for the integration.

You can get you API key at: https://trello.com/app-key

Suggest Edits

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.

Each resource in the Trello API that is nested will contain a section {Resource} Nested Resource (e.g. Actions Nested Resource) wherein the options for using the resource as a query param or a URL are outlines. When a nested resource is available via another resource, we'll link to the nested resource section.

 

Actions are generated whenever an action occurs in Trello. For instance, when a user deletes a card, a deleteCard action is generated and includes information about the deleted card, the list the card was in, the board the card was on, the user that deleted the card, and the idObject of the action. Actions for Trello objects can be listed from nested action endpoints - e.g. the resource GET boards/[board_id]/actions lists all of the actions for the given board. Additionally, data regarding individual action objects can be retrieved and updated using the resources listed below.

You Can't List Actions

If you are looking to get the actions for a resource, you'll want to use that resource's {resourceId}/actions/ endpoint.

Included at the bottom of this page are a list of all action types and action types that are not returned from nested resources.

You can see some board actions in the activity feed in the board sidebar like below:

You can see some card actions in the activity feed like below:

Suggest Edits

Action Object

 

id
string

The ID of the action

data
object

Relevant information regarding the action

date
date

When the action occurred

idMemberCreator
string

The ID of the member who caused the action

type
string

The type of the action. See list of Action Types for options.

https://api.trello.com/1/actions/592f11060f95a3d3d46a987a
{
  "id": "592f11060f95a3d3d46a987a",
  "idMemberCreator": "5191197f9433cf5507006338",
  "data": {
    "list": {
      "name": "Professional",
      "id": "54a17e9db559f0356ce022e4"
    },
    "board": {
      "shortLink": "BdarzfKF",
      "name": "Life Goals",
      "id": "54a17d76d4a5072e3931736b"
    },
    "card": {
      "shortLink": "gplJv6dx",
      "idShort": 2,
      "name": "Increase revenue by 10%",
      "id": "54a1844d304d9736e54d2546",
      "due": "2017-12-12T17:00:00.000Z"
    },
    "old": {
      "due": "2017-05-01T16:00:00.000Z"
    }
  },
  "type": "updateCard",
  "date": "2017-05-31T18:52:54.933Z",
  "memberCreator": {
    "id": "5191197f9433cf5507006338",
    "avatarHash": "ae0fde383cc2a195c053f1ad42c02022",
    "fullName": "Brian Cervino",
    "initials": "BC",
    "username": "brian"
  },
  "display": {
    "translationKey": "action_changed_a_due_date",
    "entities": {
      "card": {
        "type": "card",
        "due": "2017-12-12T17:00:00.000Z",
        "id": "54a1844d304d9736e54d2546",
        "shortLink": "gplJv6dx",
        "text": "Increase revenue by 10%"
      },
      "date": {
        "type": "date",
        "date": "2017-12-12T17:00:00.000Z"
      },
      "memberCreator": {
        "type": "member",
        "id": "5191197f9433cf5507006338",
        "username": "brian",
        "text": "Brian Cervino"
      }
    }
  }
}
Suggest Edits

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

Parameter
Valid Values
Default
Description

actions_entities
boolean

true, false

false

Boolean to return actions' entities or not.

actions_display
boolean

true, false

false

Boolean to return actions' entities or not.

actions_format
string

One of: count, list, or minimal

list

The format that actions should be returned in.

https://api.trello.com/1/boards/BdarzfKF/?fields=id&actions=addAttachmentToCard&actions_limit=2&action_fields=idMemberCreator&action_memberCreator_fields=fullName
{
  "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

entities
boolean

Default: false

display
boolean

Default: false

filter
string

Default: commentCard, updateCard:idList

fields
string

Default: all
all or a comma-separated list of:

  • data
  • date
  • idMemberCreator
  • type

limit
integer

Default: 50
0 - 1000

format
string

Default: list
One of: count, list, minimal

since
date

before
date

page
integer

Default: 0

idModels
string

Comma-separated list of model IDs

member
boolean

Default: true

member_fields
string

Default: avatarHash,fullName,initials,username
all or a comma-separated list of:

  • avatarHash
  • bio
  • bioData
  • confirmed
  • fullName
  • idPremOrgsAdmin
  • initials
  • memberType
  • products
  • status
  • url
  • username

memberCreator
boolean

Default: true

memberCreator_fields
string

Default: avatarHash,fullName,initials,username
all or a comma-separated list of:

  • avatarHash
  • bio
  • bioData
  • confirmed
  • fullName
  • idPremOrgsAdmin
  • initials
  • memberType
  • products
  • status
  • url
  • username
Suggest Edits

Action Types

Actions have many types.

 

Due to the number of actions that occur in Trello, nested action resources filter out specific action types. For example, changing the name of a checklistItem will trigger a webhook on the board and will POST an action of type updateCheckItem with the old and new name of the checklistItem. However, no nested actions resource will return action types of updateCheckItem: /cards/{id}/actions/, /boards/{id}/actions/. However you can get that specific action instance via GET /actions/{id}/.

All Action Types

Action Name
  • addAdminToBoard
  • addAdminToOrganization
  • addAttachmentToCard
  • addAdminToBoard
  • addAdminToOrganization
  • addAttachmentToCard
  • addBoardsPinnedToMember
  • addChecklistToCard
  • addLabelToCard
  • addMemberToBoard
  • addMemberToCard
  • addMemberToOrganization
  • addToOrganizationBoard
  • commentCard
  • convertToCardFromCheckItem
  • copyBoard
  • copyCard
  • copyChecklist
  • createLabel
  • copyCommentCard
  • createBoard
  • createBoardInvitation
  • createBoardPreference
  • createCard
  • createChecklist
  • createList
  • createOrganization
  • createOrganizationInvitation
  • deleteAttachmentFromCard
  • deleteBoardInvitation
  • deleteCard
  • deleteCheckItem
  • deleteLabel
  • deleteOrganizationInvitation
  • disablePlugin
  • disablePowerUp
  • emailCard
  • enablePlugin
  • enablePowerUp
  • makeAdminOfBoard
  • makeAdminOfOrganization
  • makeNormalMemberOfBoard
  • makeNormalMemberOfOrganization
  • makeObserverOfBoard
  • memberJoinedTrello
  • moveCardFromBoard
  • moveCardToBoard
  • moveListFromBoard
  • moveListToBoard
  • removeAdminFromBoard
  • removeAdminFromOrganization
  • removeBoardsPinnedFromMember
  • removeChecklistFromCard
  • removeFromOrganizationBoard
  • removeLabelFromCard
  • removeMemberFromBoard
  • removeMemberFromCard
  • removeMemberFromOrganization
  • unconfirmedBoardInvitation
  • unconfirmedOrganizationInvitation
  • updateBoard
  • updateCard
  • updateCheckItem
  • updateCheckItemStateOnCard
  • updateChecklist
  • updateLabel
  • updateList
  • updateMember
  • updateOrganization
  • voteOnCard

Excluded Action Types

These actions will be sent to Webhooks but are not included in nested action resource responses (e.g. GET board/[board_id]/actions).

Action Name
  • addAdminToBoard (Deprecated in favor of makeAdminOfBoard)
  • addAdminToOrganization (Deprecated in favor of makeAdminOfOrganization)
  • addBoardsPinnedToMember
  • addLabelToCard
  • copyChecklist
  • createBoardInvitation
  • createBoardPreference
  • createCheckItem
  • createChecklist
  • createLabel
  • createOrganizationInvitation
  • deleteCheckItem
  • deleteComment
  • deleteLabel
  • makeAdminOfOrganization
  • removeAdminFromBoard (Deprecated in favor of makeNormalMemberOfBoard)
  • removeAdminFromOrganization (Deprecated in favor of makeNormalMemberOfOrganization)
  • removeBoardsPinnedFromMember
  • removeLabelFromCard
  • removeMemberFromBoard
  • removeMemberFromOrganization
  • updateCheckItem
  • updateComment
  • updateLabel
  • voteOnCard
Suggest Edits

/actions/{id}

Get information about an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id
curl --request GET \
  --url https://api.trello.com/1/actions/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

display
boolean
entities
boolean
fields
string

all or a comma-separated list of action fields

member
boolean
member_fields
string

all or a comma-separated list of member fields

memberCreator
boolean

Whether to include the member object for the creator of the action

memberCreator_fields
string

all or a comma-separated list of member fields

 

GET /1/actions/55411859be21b8ad7dcd4c78?fields=all

{
  "id": "55411859be21b8ad7dcd4c78",
  "idMemberCreator": "54e20f22ca5e45bc555c1cdb",
  "data": {
    "board": {
      "shortLink": "nC8QJJoZ",
      "name": "Trello Development",
      "id": "4d5ea62fd76aa1136000000c"
    },
    "card": {
      "shortLink": "NIRpzVDM",
      "idShort": 1211,
      "name": "What can you expect from this board?",
      "id": "4f7dcc310113192a307f347d"
    },
    "attachment": {
      "previewUrl2x": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/1200x1176/728412168dacbfff02e9414d84a0356f/trello-logo.png",
      "previewUrl": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/600x588/09dcbeb01f2de5d29a513c6e3aad3649/trello-logo.png",
      "url": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/1294x1268/219cc6eb9c9b7b2ef8b1251c90a4184a/trello-logo.png",
      "name": "trello-logo.png",
      "id": "55411857be21b8ad7dcd4c70"
    }
  },
  "type": "addAttachmentToCard",
  "date": "2015-04-29T17:43:53.614Z",
  "memberCreator": {
    "id": "54e20f22ca5e45bc555c1cdb",
    "avatarHash": "448c93683331562616e24a04b09d41fa",
    "fullName": "Michelle Bearheart",
    "initials": "MB",
    "username": "michellebearheart"
  },
  "display": {
    "translationKey": "action_add_attachment_to_card",
    "entities": {
      "attachment": {
        "type": "attachment",
        "id": "55411857be21b8ad7dcd4c70",
        "previewUrl": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/600x588/09dcbeb01f2de5d29a513c6e3aad3649/trello-logo.png",
        "previewUrl2x": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/1200x1176/728412168dacbfff02e9414d84a0356f/trello-logo.png",
        "link": true,
        "text": "trello-logo.png",
        "url": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/1294x1268/219cc6eb9c9b7b2ef8b1251c90a4184a/trello-logo.png"
      },
      "attachmentPreview": {
        "type": "attachmentPreview",
        "originalUrl": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/1294x1268/219cc6eb9c9b7b2ef8b1251c90a4184a/trello-logo.png",
        "id": "55411857be21b8ad7dcd4c70",
        "previewUrl": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/600x588/09dcbeb01f2de5d29a513c6e3aad3649/trello-logo.png",
        "previewUrl2x": "https://trello-attachments.s3.amazonaws.com/4f7dcc310113192a307f347d/1200x1176/728412168dacbfff02e9414d84a0356f/trello-logo.png"
      },
      "card": {
        "type": "card",
        "id": "4f7dcc310113192a307f347d",
        "shortLink": "NIRpzVDM",
        "text": "What can you expect from this board?"
      },
      "memberCreator": {
        "type": "member",
        "id": "54e20f22ca5e45bc555c1cdb",
        "username": "michellebearheart",
        "text": "Michelle Bearheart"
      }
    }
  }
}
Suggest Edits

/actions/{id}/{field}

Get a specific property of an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/field
curl --request GET \
  --url https://api.trello.com/1/actions/id/field
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/field' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/field");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/field"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

field
string
required

An action field

 
Suggest Edits

/actions/{id}/board

Get the board for an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/board
curl --request GET \
  --url https://api.trello.com/1/actions/id/board
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/board' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/board")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/board");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/board"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of board fields

 
Suggest Edits

/actions/{id}/card

Get the card for an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/card
curl --request GET \
  --url https://api.trello.com/1/actions/id/card
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/card' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/card")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/card");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/card"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of card fields

 
Suggest Edits

/actions/{id}/display

Get the card for an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/card
curl --request GET \
  --url https://api.trello.com/1/actions/id/card
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/card' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/card")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/card");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/card"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of card fields

 
Suggest Edits

/actions/{id}/list

Get the list for an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/list
curl --request GET \
  --url https://api.trello.com/1/actions/id/list
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/list' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/list");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/list"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of list fields

 
Suggest Edits

/actions/{id}/member

Gets the member of an action (not the creator)

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/member
curl --request GET \
  --url https://api.trello.com/1/actions/id/member
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/member' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/member")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/member");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/member"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of member fields

 
Suggest Edits

/actions/{id}/memberCreator

Gets the member who created the action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/memberCreator
curl --request GET \
  --url https://api.trello.com/1/actions/id/memberCreator
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/memberCreator' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/memberCreator")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/memberCreator");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/memberCreator"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of member fields

 
Suggest Edits

/actions/{id}/organization

Get the organization of an action

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/actions/id/organization
curl --request GET \
  --url https://api.trello.com/1/actions/id/organization
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/actions/id/organization' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/organization")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/actions/id/organization");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/organization"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action

Query Params

fields
string

all or a comma-separated list of organization fields

 
Suggest Edits

/actions/{id}

Update a comment action

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/actions/id
curl --request PUT \
  --url 'https://api.trello.com/1/actions/id?text=text'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/actions/id',
  qs: { text: 'text' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id?text=text")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/actions/id?text=text");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id"

querystring = {"text":"text"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action to update

Query Params

text
string
required

The new text for the comment

 

Only Comment Actions

You can only use PUT on commentCard actions to update the comment. PUTing a new text value will also update the comment on the card. You can only update the comment as the member who wrote the comment, or a member with greater permissions.

Suggest Edits

/actions/{id}/text

Update a comment action

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/actions/id/text
curl --request PUT \
  --url 'https://api.trello.com/1/actions/id/text?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/actions/id/text',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id/text?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/actions/id/text?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id/text"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the action to update

Query Params

value
string
required

The new text for the comment

 

Only Comment Actions

You can only use PUT on commentCard actions to update the comment. PUTing a new text value will also update the comment on the card. You can only update the comment as the member who wrote the comment, or a member with greater permissions.

Suggest Edits

/actions/{id}

Delete a comment action

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://api.trello.com/1/actions/id
curl --request DELETE \
  --url https://api.trello.com/1/actions/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.trello.com/1/actions/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/actions/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.trello.com/1/actions/id");

xhr.send(data);
import requests

url = "https://api.trello.com/1/actions/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the commentCard action to delete

 

Only Comment Actions

You can only use DELETE on commentCard actions. Deleting a commentCard action will also delete the comment on the card. You can only delete a commentCard action if you are the one that created the comment, you have more permissions on the board than the person that created the comment, or the person that created the comment has deleted their account.

The batch endpoint allows you to make multiple GET requests to the Trello API in a single request. By batching GET requests together, you can reduce the volume of calls you are making to the API and more easily stay within your API rate limit. The batch endpoint can not be called recursively; requests containing the batch url will be ignored.

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/batch
https://api.trello.com/1/batch/?urls=/members/trello/,boards/4eea4ffc91e31d1746000046,cards/74836e2c91e31d1746008921/pluginData&key=[yourKey]&token=[yourToken]
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

urls
string
required

A list of API routes. Maximum of 10 routes allowed. The routes should begin with a forward slash and should not include the API version number - e.g. "urls=/members/trello,/cards/[cardId]"

 

Boards are fundamental to Trello. A board may belong to 0 or 1 teams and can have 0 or more lists. This is what a board looks like:

Suggest Edits

Board Object

 

id
string

The ID of the board

name
string

The name of the board

desc
string

The description of the board.
Deprecated

descData
string or null

If the description includes custom emoji, this will contain the data necessary to display them.

closed
boolean

Boolean whether the board has been closed or not.

idOrganization
string

MongoID of the organization to which the board belongs.

pinned
boolean

Boolean whether the board has been pinned or not.

url
string

Persistent URL for the board.

shortUrl
string

URL for the board using only it's shortMongoID

prefs
object

Short for "preferences", these are the settings for the board

labelNames
object

Object containing color keys and the label names given for each color on the board.

GET /1/boards/586e8f681d4fe9b06a928307

{
  "id": "586e8f681d4fe9b06a928307",
  "name": "Best Test Board!",
  "desc": "",
  "descData": null,
  "closed": false,
  "idOrganization": "586e8d7b1af892b26d5b76b1",
  "pinned": false,
  "url": "https://trello.com/b/d2EnEWSY/best-test-board",
  "shortUrl": "https://trello.com/b/d2EnEWSY",
  "prefs": {
    "permissionLevel": "org",
    "voting": "disabled",
    "comments": "disabled",
    "invitations": "admins",
    "selfJoin": true,
    "cardCovers": true,
    "cardAging": "pirate",
    "calendarFeedEnabled": false,
    "background": "58cac0e474e47e3ff248cc47",
    "backgroundImage": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/1940x900/e55fff446a627e377b4e9ab9d7fcb552/boulder.jpg.png",
    "backgroundImageScaled": [
      {
        "width": 140,
        "height": 100,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/140x100/27e2b3c47f9a4776398ce51713295f2a/boulder.jpg.png"
      },
      {
        "width": 256,
        "height": 192,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/256x192/c397db11033a0e700b78ad70d8df8f34/boulder.jpg.png"
      },
      {
        "width": 480,
        "height": 480,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/480x480/abdad371090525973507a4f1d05330bb/boulder.jpg.png"
      },
      {
        "width": 960,
        "height": 960,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/960x960/ef29a1b58721eabcecdbefea70721d8e/boulder.jpg.png"
      },
      {
        "width": 1024,
        "height": 1024,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/1024x1024/6ffd7ac942b9a13b21ad28ade1ae708b/boulder.jpg.png"
      },
      {
        "width": 1940,
        "height": 900,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/1940x900/e55fff446a627e377b4e9ab9d7fcb552/boulder.jpg.png"
      },
      {
        "width": 1280,
        "height": 1280,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/1280x1280/13458f1524dd1a06a9ee2284932c1f56/boulder.jpg.png"
      },
      {
        "width": 1920,
        "height": 1920,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/1920x1920/81e98622f09850d488e3fc533b7e72fc/boulder.jpg.png"
      },
      {
        "width": 1940,
        "height": 900,
        "url": "https://trello-backgrounds.s3.amazonaws.com/5589c3ea49b40cedc28cf70e/1940x900/c29d61a839e47a350bfbded036eefc3e/boulder.jpg"
      }
    ],
    "backgroundTile": false,
    "backgroundBrightness": "light",
    "canBePublic": true,
    "canBeOrg": true,
    "canBePrivate": true,
    "canInvite": true
  },
  "labelNames": {
    "green": "",
    "yellow": "",
    "orange": "",
    "red": "",
    "purple": "",
    "blue": "",
    "sky": "Test Label 1",
    "lime": "Test Label 2",
    "pink": "",
    "black": "New Label!"
  }
}
Suggest Edits

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

boards

Default: none

all or a comma-separated list of:

  • open - Returns all boards that are open.
  • closed - Returns all boards that have been closed.
  • members - Returns all boards that have visibility set to Private.
  • organization - Returns all boards that have visibility set to Team.
  • public - Returns all boards that have visibility set to Public.
  • starred - Returns all boards that have been starred.

board_fields

Default: all

all or a comma-separated list of board fields

board_actions

all or a comma-separated list of:

  • addAttachmentToCard
  • addChecklistToCard
  • addMemberToBoard
  • addMemberToCard
  • addMemberToOrganization
  • addToOrganizationBoard
  • commentCard
  • convertToCardFromCheckItem
  • copyBoard
  • copyCard
  • copyCommentCard
  • createBoard
  • createCard
  • createList
  • createOrganization
  • deleteAttachmentFromCard
  • deleteBoardInvitation
  • deleteCard
  • deleteOrganizationInvitation
  • disablePowerUp
  • emailCard
  • enablePowerUp
  • makeAdminOfBoard
  • makeNormalMemberOfBoard
  • makeNormalMemberOfOrganization
  • makeObserverOfBoard
  • memberJoinedTrello
  • moveCardFromBoard
  • moveCardToBoard
  • moveListFromBoard
  • moveListToBoard
  • removeChecklistFromCard
  • removeFromOrganizationBoard
  • removeMemberFromCard
  • unconfirmedBoardInvitation
  • unconfirmedOrganizationInvitation
  • updateBoard
  • updateCard
  • updateCard:closed
  • updateCard:desc
  • updateCard:idList
  • updateCard:name
  • updateCheckItemStateOnCard
  • updateChecklist
  • updateList
  • updateList:closed
  • updateList:name
  • updateMember
  • updateOrganization

board_actions_entities

Default: false
true or false

board_actions_display

Default: false
true or false

board_actions_format

Default: list
One of: count, list, minimal

board_actions_since

A date, null, or lastView

board_actions_limit

Default: 50
Max: 1000

board_action_fields

all or a comma-separated list of action fields

board_lists

Default: none
One of: all, closed, none, open

board_pluginData

Default: false
true or false

Suggest Edits

/boards/{id}

Request a single board.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id
https://api.trello.com/1/boards/tBmYPSYe?fields=id,name,idOrganization,dateLastActivity&lists=open&list_fields=id,name&key=[key]&token=[token]
curl --request GET \
  --url https://api.trello.com/1/boards/tBmYPSYe?fields=id,name,idOrganization,dateLastActivity&lists=open&list_fields=id,name
import requests

url = "https://api.trello.com/1/boards/tBmYPSYe?fields=id,name,idOrganization,dateLastActivity&lists=open&list_fields=id,name"

response = requests.request("GET", url)

print(response.text)
Trello.boards.get(
  {boardId}, 
  {fields: ['id', 'labels', 'powerUps']},
  (response) => console.log(`Success: ${response}`),
  (response) => console.log(`Error: ${response}`)
)
A binary file was returned

You couldn't be authenticated

{
  "id": "560bf4298b3dda300c18d09c",
  "name": "US National Parks",
  "idOrganization": "577eb8850b41e08c3034aae2",
  "dateLastActivity": "2016-08-07T00:49:38.995Z",
  "lists": [
    {
      "id": "560bf446f17023a3710658fb",
      "name": "Alaska"
    },
    {
      "id": "560bf44ea68b16bd0fc2a9a9",
      "name": "Arizona"
    },
    {
      "id": "560bf4505d1d723b142c2c0a",
      "name": "Arkansas"
    },
    {
      "id": "560bf45374e3026dca43aedb",
      "name": "California"
    },
    {
      "id": "560bf45b7e62e2cb4852388b",
      "name": "Colorado"
    }
    ...
  ]
}
board not found
invalid token

Path Params

id
string
required

Query Params

actions
string

This is a nested resource. Read more about actions as nested resources here.

boardStars
string

Valid values are one of: mine or none.

cards
string

This is a nested resource. Read more about cards as nested resources here.

card_pluginData
boolean

Use with the cards param to include card pluginData with the response

checklists
string

This is a nested resource. Read more about checklists as nested resources here.

fields
string

The fields of the board to be included in the response. Valid values: all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url

labels
string

This is a nested resource. Read more about labels as nested resources here.

lists
string

This is a nested resource. Read more about lists as nested resources here.

members
string

This is a nested resource. Read more about members as nested resources here.

memberships
string

This is a nested resource. Read more about memberships as nested resources here.

membersInvited
string

Returns a list of member objects representing members who been invited to be a member of the board. One of: admins, all, none, normal, owners

membersInvited_fields
string

The member fields to be included in the membersInvited response. Valid values: all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username

pluginData
boolean

Determines whether the pluginData for this board should be returned. Valid values: true or false.

organization
boolean

This is a nested resource. Read more about organizations as nested resources here.

organization_pluginData
boolean

Use with the organization param to include organization pluginData with the response

myPrefs
boolean
tags
boolean

Also known as collections, tags, refer to the collection(s) that a Board belongs to.

 
Suggest Edits

/boards/{id}/{field}

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/field
curl https://api.trello.com/1/boards/9clNtU6v/shortUrl
A binary file was returned

You couldn't be authenticated

{
"_value": "https://trello.com/b/9clNtU6v"
}

Path Params

id
string
required

The ID of the board.

field
string
required

The field you'd like to receive. Valid values: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url.

 
Suggest Edits

/boards{id}/actions

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/boardId/actions
curl https://api.trello.com/1/boards/d2EnEWSY/actions/?limit=2
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "5939a82bcb0811201c349bf9",
    "idMemberCreator": "5589c3ea49b40cedc28cf70e",
    "data": {
      "list": {
        "name": "Done",
        "id": "58dba95aa3fca404ad62476c"
      },
      "board": {
        "shortLink": "d2EnEWSY",
        "name": "Best Test Board!",
        "id": "586e8f681d4fe9b06a928307"
      },
      "card": {
        "shortLink": "HKaaH2Pk",
        "idShort": 94,
        "name": "Design New System",
        "id": "5939a829eba57d109331a289",
        "pos": 229375
      },
      "old": {
        "pos": 163839.5
      }
    },
    "type": "updateCard",
    "date": "2017-06-08T19:40:27.915Z",
    "memberCreator": {
      "id": "5589c3ea49b40cedc28cf70e",
      "avatarHash": "d24f1fe1d7da4b5aab5243ebd65af4a1",
      "fullName": "Bentley Cook",
      "initials": "BC",
      "username": "bentleycook"
    }
  },
  {
    "id": "5939a82bcb0811201c349bf8",
    "idMemberCreator": "5589c3ea49b40cedc28cf70e",
    "data": {
      "listAfter": {
        "name": "Done",
        "id": "58dba95aa3fca404ad62476c"
      },
      "listBefore": {
        "name": "Doing",
        "id": "58d4144e4ec5c792a898d4b4"
      },
      "board": {
        "shortLink": "d2EnEWSY",
        "name": "Best Test Board!",
        "id": "586e8f681d4fe9b06a928307"
      },
      "card": {
        "shortLink": "HKaaH2Pk",
        "idShort": 94,
        "name": "Design New System",
        "id": "5939a829eba57d109331a289",
        "idList": "58dba95aa3fca404ad62476c"
      },
      "old": {
        "idList": "58d4144e4ec5c792a898d4b4"
      }
    },
    "type": "updateCard",
    "date": "2017-06-08T19:40:27.878Z",
    "memberCreator": {
      "id": "5589c3ea49b40cedc28cf70e",
      "avatarHash": "d24f1fe1d7da4b5aab5243ebd65af4a1",
      "fullName": "Bentley Cook",
      "initials": "BC",
      "username": "bentleycook"
    }
  }
]
unauthorized permission requested
invalid id

Path Params

boardId
string
required
 

Board Actions

There are a lot of things you can do with this endpoint. It is a nested resource. For more information and to see everything you can do with actions, be sure to check out the actions documentation. All of the query params found there can be used here.

Board Specific Actions

Only actions specific to the board will be shown.

Suggest Edits

/boards/{id}/boardPlugins

Get the enabled Power-Ups on a board

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/boardPlugins
https://api.trello.com/1/boards/nC8QJJoZ/boardPlugins
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "5846f8577b05f61b7a6f3971",
    "idBoard": "4d5ea62fd76aa1136000000c",
    "idPlugin": "55a5d917446f517774210013"
  },
  {
    "id": "5846f99996b59c33ab555249",
    "idBoard": "4d5ea62fd76aa1136000000c",
    "idPlugin": "568c143d95adcd7308cbc3fb"
  }
]

Path Params

id
string
required

The ID of the board

 
Suggest Edits

/boards/{id}/boardStars

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/boardId/boardStars
https://trello.com/1/boards/d2EnEWSY/?fields=id&boardStars=mine
A binary file was returned

You couldn't be authenticated

{
  "id": "586e8f681d4fe9b06a928307",
  "boardStars": [
    {
      "_id": "59370b012373f371a531b73d",
      "idBoard": "586e8f681d4fe9b06a928307",
      "pos": 360448
    }
  ]
}

Path Params

boardId
string
required
filter
string
required

Valid values: mine, none

 
Suggest Edits

/boards/{id}/cards

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/cards
https://api.trello.com/1/boards/d2EnEWSY/cards/?limit=2&fields=name&members=true&member_fields=fullName&key=[yourKey]&token=[yourToken]
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "5941465a11d2c760d95b95ad",
    "name": "Checklists",
    "members": []
  },
  {
    "id": "5939a829eba57d109331a289",
    "name": "Design New System",
    "members": [
      {
        "id": "5589c3ea49b40cedc28cf70e",
        "fullName": "Bentley Cook"
      }
    ]
  }
]

Path Params

id
string
required
 

This resource is a nested card resource. Nested cards are documented here. The cards returned by this resource will be within the context of the board whose ID is being used.

Suggest Edits

/boards/{id}/cards/{filter}

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/boardId/cards/filter
https://trello.com/1/boards/d2EnEWSY/cards/closed
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "59394c1939fc59910b4f7cfd",
    "checkItemStates": null,
    "closed": true,
    "dateLastActivity": "2017-06-08T13:07:57.302Z",
    "desc": "",
    "descData": null,
    "idBoard": "586e8f681d4fe9b06a928307",
    "idList": "58d4144e4ec5c792a898d4b4",
    "idMembersVoted": [],
    "idShort": 93,
    "idAttachmentCover": null,
    "manualCoverAttachment": false,
    "idLabels": [],
    "name": "Test",
    "pos": 163839.5,
    "shortLink": "vxzyFCkF",
    "badges": {
      "votes": 0,
      "viewingMemberVoted": false,
      "subscribed": false,
      "fogbugz": "",
      "checkItems": 0,
      "checkItemsChecked": 0,
      "comments": 0,
      "attachments": 0,
      "description": false,
      "due": null,
      "dueComplete": false
    },
    "dueComplete": false,
    "due": null,
    "idChecklists": [],
    "idMembers": [],
    "labels": [],
    "shortUrl": "https://trello.com/c/vxzyFCkF",
    "subscribed": false,
    "url": "https://trello.com/c/vxzyFCkF/93-test"
  }
]

Path Params

boardId
string
required
filter
string
required

Valid Values: all, closed, none, open, visible.

 
Suggest Edits

/boards/{id}/cards/{cardId}

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/cards/idCard
https://trello.com/1/boards/d2EnEWSY/cards/59394c1939fc59910b4f7cfd
A binary file was returned

You couldn't be authenticated

{
  "id": "59394c1939fc59910b4f7cfd",
  "badges": {
    "votes": 0,
    "viewingMemberVoted": false,
    "subscribed": false,
    "fogbugz": "",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 0,
    "description": false,
    "due": null,
    "dueComplete": false
  },
  "checkItemStates": [],
  "closed": true,
  "dueComplete": false,
  "dateLastActivity": "2017-06-08T13:07:57.302Z",
  "desc": "",
  "descData": null,
  "due": null,
  "email": null,
  "idBoard": "586e8f681d4fe9b06a928307",
  "idChecklists": [],
  "idList": "58d4144e4ec5c792a898d4b4",
  "idMembers": [],
  "idMembersVoted": [],
  "idShort": 93,
  "idAttachmentCover": null,
  "manualCoverAttachment": false,
  "labels": [],
  "idLabels": [],
  "name": "Test",
  "pos": 163839.5,
  "shortLink": "vxzyFCkF",
  "shortUrl": "https://trello.com/c/vxzyFCkF",
  "subscribed": false,
  "url": "https://trello.com/c/vxzyFCkF/93-test"
}

Path Params

id
string
required

The ID of the board

idCard
string
required

The id the card to retrieve.

 

This resource is used to retrieve individual cards on a board. It is a nested version of the cards object. For more on the query parameters available, read the documentation here.

Suggest Edits

/boards/{id}/checklists

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/checklists
https://api.trello.com/1/boards/d2EnEWSY/checklists?checkItem_fields=name&fields=name&token=[yourToken]&key=[yourKey]
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "586eb0f532487bceb8b75aca",
    "name": "Checklist",
    "checkItems": [
      {
        "idChecklist": "586eb0f532487bceb8b75aca",
        "id": "586eb0f6599c7bcf2c5116bc",
        "name": "1"
      },
      {
        "idChecklist": "586eb0f532487bceb8b75aca",
        "id": "586eb0f64e39386b8b101675",
        "name": "2"
      },
      {
        "idChecklist": "586eb0f532487bceb8b75aca",
        "id": "586eb0f740aec762d6601f6a",
        "name": "3"
      }
    ]
  },
  {
    "id": "586eb2770c9dc27f034162f7",
    "name": "Checklist",
    "checkItems": []
  }
]

Path Params

id
string
required

The ID of the board

 

This resource is used to retrieve checklists from cards on the board with the given id. It is a nested version of the checklists object. For more on the query parameters available, read the documentation here.

Suggest Edits

/boards/{id}/tags

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/tags
curl --request GET \
  --url https://api.trello.com/1/boards/id/tags
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/boards/id/tags' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/tags")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/boards/id/tags");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/tags"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

 

Experimental Resource

Warning: This is an experimental resource and may change at any time without notice.

Returns a list of idTags that represent the collections that the board has been added to.

Suggest Edits

/boards/{id}/labels

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/labels
curl --request GET \
  --url https://api.trello.com/1/boards/id/labels
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/boards/id/labels' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/labels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/boards/id/labels");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/labels"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

Query Params

fields
string

all or a comma-separated list of label fields

limit
int32

0 to 1000

 
GET https://api.trello.com/1/boards/ZqN99gGN/labels?limit=3&fields=name,color
[
  {
    "id": "57a890c6504676888e1dd747",
    "name": "Verified on branch",
    "color": "yellow"
  },
  {
    "id": "57a890c6504676888e1dd74a",
    "name": "Regression",
    "color": "purple"
  },
  {
    "id": "57a890c6504676888e1dd74b",
    "name": "Verified on staging",
    "color": "blue"
  }
]
Suggest Edits

/boards/{id}/lists

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/lists
curl --request GET \
  --url https://api.trello.com/1/boards/id/lists
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/boards/id/lists' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/lists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/boards/id/lists");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/lists"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

Query Params

cards
string

One of: all, closed, none, open, visible

card_fields
string

all or a comma-separated list of card fields

filter
string

One of all, closed, none, open

fields
string

all or a comma-separated list of list fields

 
GET https://trello.com/1/boards/ZqN99gGN/lists?cards=open&card_fields=name&filter=open&fields=name
[
  {
    "id": "57a890c6504676888e1dd737",
    "name": "Backlog",
    "cards": [
      {
        "id": "57a890c7504676888e1dd818",
        "name": "Product Owner: Brian"
      },
      {
        "id": "57a890c7504676888e1dd7e5",
        "name": "(3) fix /org/:id route"
      }
    ]
  },
  {
    "id": "57a890c6504676888e1dd738",
    "name": "Sprint Backlog",
    "cards": [
      {
        "id": "57a890c6504676888e1dd776",
        "name": "(8) Clicking the collection beneath a board should filter by collection, not open collections pop-over"
      },
      {
        "id": "57a890c7504676888e1dd7f0",
        "name": "(2) BC3 team boards page: Show Other Private Boards"
      },
      {
        "id": "57a890c6504676888e1dd772",
        "name": "(1) Add post-message-io"
      }
    ]
  },
  {
    "id": "57a890c6504676888e1dd739",
    "name": "In Progress",
    "cards": [
      {
        "id": "57a248d3977a6e388bf6cb80",
        "name": "Multiple due dates"
      }
    ]	
  }
]
Suggest Edits

/boards/{id}/lists/{filter}

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/lists/filter
curl --request GET \
  --url https://api.trello.com/1/boards/id/lists/filter
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/boards/id/lists/filter' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/lists/filter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/boards/id/lists/filter");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/lists/filter"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

filter
string
required

One of all, closed, none, open

 
Suggest Edits

/boards/{id}/members

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/members
curl --request GET \
  --url https://api.trello.com/1/boards/id/members
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/boards/id/members' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/boards/id/members");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/members"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

Query Params

filter
string

One of admins, all, none, normal, owners

fields
string

all or a comma-separated list of member fields

activity
boolean

Works for premium organizations only

 
Suggest Edits

/boards/{id}/plugins

List the Power-Ups for a board

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/boards/id/plugins
https://api.trello.com/1/boards/nC8QJJoZ/plugins?filter=enabled
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "55a5d917446f517774210013",
    "name": "Voting",
    "public": true,
    "url": "https://voting.trello.services/manifest.json"
  },
  {
    "id": "568c143d95adcd7308cbc3fb",
    "name": "SurveyMonkey",
    "public": true,
    "url": "https://surveymonkey.trello.services/manifest.json"
  }
]

Path Params

id
string
required

The ID of the board

Query Params

filter
string

One of: enabled or available

 
Suggest Edits

/boards/{id}

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id
curl --request PUT \
  --url https://api.trello.com/1/boards/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

name
string

The new name for the board. 1 to 16384 characters long.

desc
string

A new description for the board, 0 to 16384 characters long

closed
boolean

Whether the board is closed

subscribed
boolean

Whether the acting user is subscribed to the board

idOrganization
string

The id of the team the board should be moved to

prefs/permissionLevel
string

One of: org, private, public

prefs/selfJoin
boolean

Whether team members can join the board themselves

prefs/cardCovers
boolean

Whether card covers should be displayed on this board

prefs/invitations
string

Who can invite people to this board. One of: admins, members

prefs/voting
string

Who can vote on this board. One of disabled, members, observers, org, public

prefs/comments
string

Who can comment on cards on this board. One of: disabled, members, observers, org, public

prefs/background
string

The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey

prefs/cardAging
string

One of: pirate, regular

prefs/calendarFeedEnabled
boolean

Determines whether the calendar feed is enabled or not.

labelNames/green
string

Name for the green label. 1 to 16384 characters long

labelNames/yellow
string

Name for the yellow label. 1 to 16384 characters long

labelNames/orange
string

Name for the orange label. 1 to 16384 characters long

labelNames/red
string

Name for the red label. 1 to 16384 characters long

labelNames/purple
string

Name for the purple label. 1 to 16384 characters long

labelNames/blue
string

Name for the blue label. 1 to 16384 characters long

 

This endpoint can be used to update one or more properties of the card at once. Alternatively, you can also update a single property of the card as the params for this method via:

PUT /1/boards/{id}/{property}?value={newValue}

So for example, to archive a board:

PUT /1/boards/{id}/closed?value=true

Or to update the name of a board:

PUT /1/boards/{id}/name?value={new board name}

Suggest Edits

/boards/{id}/members

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/members
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/members?email=email' \
  --header 'type: type'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/members',
  qs: { email: 'email' },
  headers: { type: 'type' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/members?email=email")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["type"] = 'type'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/members?email=email");
xhr.setRequestHeader("type", "type");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/members"

querystring = {"email":"email"}

headers = {'type': 'type'}

response = requests.request("PUT", url, headers=headers, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

email
string
required

The email address of a user to add as a member of the board.

Body Params

fullName
string

The full name of the user to as a member of the board. Must have a length of at least 1 and cannot begin nor end with a space.

Headers

type
string
required

Valid values: admin, normal, observer. Determines what type of member the user being added should be of the board.

 
Suggest Edits

/boards/{id}/members/{idMember}

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/members/idMember
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/members/idMember?idMember=idMember&type=type'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/members/idMember',
  qs: 
   { idMember: 'idMember',
     type: 'type' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/members/idMember?idMember=idMember&type=type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/members/idMember?idMember=idMember&type=type");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/members/idMember"

querystring = {"idMember":"idMember","type":"type"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

idMember
string
required

The id, username, or organization name to be added as a member of this board.

type
string
required

One of: admin, normal, observer. Determines the type of member this user will be on the board.

 
Suggest Edits

/boards/{id}/memberships/{idMembership}

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/memberships/idMembership
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/memberships/idMembership?idMembership=idMembership&type=type'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/memberships/idMembership',
  qs: 
   { idMembership: 'idMembership',
     type: 'type' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/memberships/idMembership?idMembership=idMembership&type=type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/memberships/idMembership?idMembership=idMembership&type=type");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/memberships/idMembership"

querystring = {"idMembership":"idMembership","type":"type"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

idMembership
string
required

The id of a membership that should be added to this board.

type
string
required

One of: admin, normal, observer. Determines the type of member that this membership will be to this board.

member_fields
string

Valid values: all, avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url, username

 
Suggest Edits

/boards/{id}/myPrefs/emailPosition

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/emailPosition
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/emailPosition?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/emailPosition',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/emailPosition?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/emailPosition?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/emailPosition"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
string
required

Valid values: bottom, top. Determines the position of the email address.

 
Suggest Edits

/boards/{id}/myPrefs/idEmailList

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/idEmailList
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/idEmailList?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/idEmailList',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/idEmailList?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/idEmailList?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/idEmailList"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
string
required

The id of an email list.

 
Suggest Edits

/boards/{id}/myPrefs/showListGuide

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/showListGuide
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/showListGuide?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/showListGuide',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/showListGuide?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/showListGuide?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/showListGuide"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
boolean
required

Determines whether to show the list guide.

 
Suggest Edits

/boards/{id}/myPrefs/showSidebar

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/showSidebar
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/showSidebar?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/showSidebar',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/showSidebar?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/showSidebar?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/showSidebar"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
boolean
required

Determines whether to show the side bar.

 
Suggest Edits

/boards/{id}/myPrefs/showSidebarActivity

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/showSidebarActivity
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/showSidebarActivity?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/showSidebarActivity',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/showSidebarActivity?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/showSidebarActivity?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/showSidebarActivity"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
boolean
required

Determines whether to show sidebar activity.

 
Suggest Edits

/boards/{id}/myPrefs/showSidebarBoardActions

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/showSidebarBoardActions
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/showSidebarBoardActions?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/showSidebarBoardActions',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/showSidebarBoardActions?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/showSidebarBoardActions?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/showSidebarBoardActions"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
boolean
required

Determines whether to show the sidebar board actions.

 
Suggest Edits

/boards/{id}/myPrefs/showSidebarMembers

Update an existing board by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://api.trello.com/1/boards/id/myPrefs/showSidebarMembers
curl --request PUT \
  --url 'https://api.trello.com/1/boards/id/myPrefs/showSidebarMembers?value=value'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.trello.com/1/boards/id/myPrefs/showSidebarMembers',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/myPrefs/showSidebarMembers?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.trello.com/1/boards/id/myPrefs/showSidebarMembers?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/myPrefs/showSidebarMembers"

querystring = {"value":"value"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
boolean
required

Determines whether to show members of the board in the sidebar.

 
Suggest Edits

/boards/

Create a new board.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/
curl --request POST \
  --url 'https://api.trello.com/1/boards/?name=name'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/',
  qs: { name: 'name' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/?name=name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/?name=name");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/"

querystring = {"name":"name"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

name
string
required

The new name for the board. 1 to 16384 characters long.

defaultLabels
boolean

Determines whether to use the default set of labels.

defaultLists
boolean

Determines whether to use the default set of lists.

desc
string

A new description for the board, 0 to 16384 characters long

idOrganization
string

The id or name of the team the board should belong to.

idBoardSource
string

The id of a board to copy into the new board.

keepFromSource
string

Components of the source board to copy.

powerUps
string

The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting.

prefs_permissionLevel
string

The permissions level of the board. One of: org, private, public.

prefs_voting
string

Who can vote on this board. One of disabled, members, observers, org, public.

prefs_comments
string

Who can comment on cards on this board. One of: disabled, members, observers, org, public.

prefs_invitations
string

Determines what types of members can invite users to join. One of: admins, members.

prefs_selfJoin
boolean

Determines whether users can join the boards themselves or whether they have to be invited.

prefs_cardCovers
boolean

Determines whether card covers are enabled.

prefs_background
string

The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey.

prefs_cardAging
string

Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.

 
Suggest Edits

/boards/{id}/boardPlugins

Enable a Power-Up on a board

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/boardPlugins
curl --request POST \
  --url https://api.trello.com/1/boards/id/boardPlugins
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/boardPlugins' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/boardPlugins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/boardPlugins");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/boardPlugins"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

Query Params

idPlugin
string

The ID of the Power-Up to enable

 
Suggest Edits

/boards/{id}/calendarKey/generate

Create a new board.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/calendarKey/generate
curl --request POST \
  --url https://api.trello.com/1/boards/id/calendarKey/generate
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/calendarKey/generate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/calendarKey/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/calendarKey/generate");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/calendarKey/generate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

 

This endpoint is used to generate a new key for the calendar to make use of.

Suggest Edits

/boards/{id}/checklists

Create a new board.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/checklists
curl --request POST \
  --url 'https://api.trello.com/1/boards/id/checklists?name=name'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/checklists',
  qs: { name: 'name' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/checklists?name=name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/checklists?name=name");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/checklists"

querystring = {"name":"name"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

name
string
required

The name of the checklist to be created. 1 to 16384 characters long.

 

This resource is used to create a new checklist on the board.

Suggest Edits

/boards/{id}/emailKey/generate

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/emailKey/generate
curl --request POST \
  --url https://api.trello.com/1/boards/id/emailKey/generate
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/emailKey/generate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/emailKey/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/emailKey/generate");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/emailKey/generate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

 

This resource is used to generate a new key to be used for email.

Suggest Edits

/boards/{id}/idTags

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/idTags
curl --request POST \
  --url 'https://api.trello.com/1/boards/id/idTags?value=value'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/idTags',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/idTags?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/idTags?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/idTags"

querystring = {"value":"value"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
string
required

The id of a tag from the organization to which this board belongs.

 

Warning: Experimental

This is an experimental resource and may change at any time without notice.

Suggest Edits

/boards/{id}/labels

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/labels
curl --request POST \
  --url 'https://api.trello.com/1/boards/id/labels?name=name&color=color'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/labels',
  qs: 
   { name: 'name',
     color: 'color' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/labels?name=name&color=color")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/labels?name=name&color=color");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/labels"

querystring = {"name":"name","color":"color"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

name
string
required

The name of the label to be created. 1 to 16384 characters long.

color
string
required

Sets the color of the new label. Valid values are a label color or null.

 
Suggest Edits

/boards/{id}/lists

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/checklists
curl --request POST \
  --url 'https://api.trello.com/1/boards/id/checklists?name=name'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/checklists',
  qs: { name: 'name' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/checklists?name=name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/checklists?name=name");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/checklists"

querystring = {"name":"name"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

name
string
required

The name of the list to be created. 1 to 16384 characters long.

pos
string

Determines the position of the list. Valid values: top, bottom, or a positive number.

 
Suggest Edits

/boards/{id}/markedAsViewed

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/checklists
curl --request POST \
  --url https://api.trello.com/1/boards/id/checklists
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/checklists' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/checklists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/checklists");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/checklists"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

 
Suggest Edits

/boards/{id}/powerUps

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.trello.com/1/boards/id/powerUps
curl --request POST \
  --url 'https://api.trello.com/1/boards/id/powerUps?value=value'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.trello.com/1/boards/id/powerUps',
  qs: { value: 'value' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/powerUps?value=value")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.trello.com/1/boards/id/powerUps?value=value");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/powerUps"

querystring = {"value":"value"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

Query Params

value
string
required

The Power-Up to be enabled on the board. One of: calendar, cardAging, recap, voting.

 
Suggest Edits

/boards/{id}/boardPlugins/{idPlugin}

Disable a Power-Up on a board

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://api.trello.com/1/boards/id/boardPlugins
curl --request DELETE \
  --url https://api.trello.com/1/boards/id/boardPlugins
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.trello.com/1/boards/id/boardPlugins' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/boardPlugins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.trello.com/1/boards/id/boardPlugins");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/boardPlugins"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the board

Query Params

idPlugin
string

The ID of the Power-Up to disable

 
Suggest Edits

/boards/{id}/members/{idMember}

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://api.trello.com/1/boards/id/members/idMember
curl --request DELETE \
  --url https://api.trello.com/1/boards/id/members/idMember
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.trello.com/1/boards/id/members/idMember' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/members/idMember")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.trello.com/1/boards/id/members/idMember");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/members/idMember"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

idMember
string
required

The id, username, or organization name of the user to be removed from the board.

 
Suggest Edits

/boards/{id}/powerUps/{powerUp}

 

Query Auth

 Authentication is required for this endpoint.
deletehttps://api.trello.com/1/boards/id/powerUps/powerUp
curl --request DELETE \
  --url https://api.trello.com/1/boards/id/powerUps/powerUp
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.trello.com/1/boards/id/powerUps/powerUp' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/boards/id/powerUps/powerUp")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.trello.com/1/boards/id/powerUps/powerUp");

xhr.send(data);
import requests

url = "https://api.trello.com/1/boards/id/powerUps/powerUp"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the board to update

powerUp
string
required

The Power-Up to be enabled on the board. One of: calendar, cardAging, recap, voting.

 

Lists in Trello contain cards. A card belongs to exactly one list.

For display purposes, cards have a front:

And a back:

Suggest Edits

Card Object

 

id
string

The ID of the card

badges
Object

Pieces of information about the card that are displayed on the front of the card.

"badges": {
    "votes": 0,
    "viewingMemberVoted": false,
    "subscribed": true,
    "fogbugz": "",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 1,
    "attachments": 2,
    "description": true,
    "due": null,
    "dueComplete": false
  }

checkItemStates
array

closed
boolean

Whether the card is closed (archived)

dateLastActivity
date

The datetime of the last activity on the card.

Note: There are activities that update dateLastActivity that do not create a corresponding action. For instance, updating the name field of a checklist item on a card does not create an action but does update the card and board's dateLastActivity value.

desc
string

The description for the card. Up to 16384 chars.

descData

If the description has custom emoji, this field will provide the data necessary to display them.

"descData": {
    "emoji": {
      "morty": "https://trello-emoji.s3.amazonaws.com/556c8537a1928ba745504dd8/f40ea4f5ecea8443875c27986760d8b3/tumblr_nszc7944yh1uccyhso1_1280.png"
    }
  }

due
date

The due date on the card, if one exists

dueComplete
boolean

Whether the due date has been marked complete

email
string

Requires write access to be returned

idAttachmentCover
string

The id of the attachment selected as the cover image, if one exists

idBoard
string

The ID of the board the card is on

idChecklists
array of strings

An array of checklist IDs that are on this card

idLabels
array of strings

An array of label IDs that are on this card

idList
string

The ID of the list the card is in

idMembers
array of strings

An array of member IDs that are on this card

idMembersVoted
array of strings

An array of member IDs who have voted on this card

idShort
integer

Numeric ID for the card on this board. Only unique to the board, and subject to change as the card moves

labels
array of Labels

Array of label objects on this card

manualCoverAttachment
boolean

Whether the card cover image was selected automatically by Trello, or manually by the user

name
string

Name of the card

pos
float

Position of the card in the list

shortLink
string

The 8 character shortened ID for the card

shortUrl
string

URL to the card without the name slug

subscribed
boolean

Whether this member is subscribed to the card

url
string

Full URL to the card, with the name slug

For example:

GET /1/cards/560bf4dd7139286471dc009c?fields=all

{
  "id": "560bf4dd7139286471dc009c",
  "badges": {
    "votes": 0,
    "viewingMemberVoted": false,
    "subscribed": true,
    "fogbugz": "",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 2,
    "description": false,
    "due": null,
    "dueComplete": false
  },
  "checkItemStates": [
    
  ],
  "closed": false,
  "dueComplete": false,
  "dateLastActivity": "2017-06-26T17:39:49.583Z",
  "desc": "",
  "descData": null,
  "due": null,
  "email": null,
  "idBoard": "560bf4298b3dda300c18d09c",
  "idChecklists": [
    
  ],
  "idList": "560bf44ea68b16bd0fc2a9a9",
  "idMembers": [
    "556c8537a1928ba745504dd8"
  ],
  "idMembersVoted": [
    
  ],
  "idShort": 9,
  "idAttachmentCover": "5944a06460ed0bee471ad8e0",
  "manualCoverAttachment": false,
  "labels": [
    {
      "id": "560bf42919ad3a5dc29f33c5",
      "idBoard": "560bf4298b3dda300c18d09c",
      "name": "Visited",
      "color": "green",
      "uses": 15
    }
  ],
  "idLabels": [
    "560bf42919ad3a5dc29f33c5"
  ],
  "name": "Grand Canyon National Park",
  "pos": 16384,
  "shortLink": "nqPiDKmw",
  "shortUrl": "https://trello.com/c/nqPiDKmw",
  "subscribed": true,
  "url": "https://trello.com/c/nqPiDKmw/9-grand-canyon-national-park"
}
Suggest Edits

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

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}?cards=visible.

cards

  • all
  • cllosed
  • none
  • open
  • visible

card_fields

Default: all

all or a comma-separated list of card fields

card_members

Default: false

true or false

card_member_fields

Default: ``

all or a comma-separated list of member fields

card_attachments

true, false, or cover

card_attachment_fields

Default: url,previews

all or a comma-separated list of attachment fields

card_stickers

Default: false

true or false

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.

actions

all or a comma-separated list of:

  • addAttachmentToCard
  • addChecklistToCard
  • addMemberToBoard
  • addMemberToCard
  • addMemberToOrganization
  • addToOrganizationBoard
  • commentCard
  • convertToCardFromCheckItem
  • copyBoard
  • copyCard
  • copyCommentCard
  • createBoard
  • createCard
  • createList
  • createOrganization
  • deleteAttachmentFromCard
  • deleteBoardInvitation
  • deleteCard
  • deleteOrganizationInvitation
  • disablePowerUp
  • emailCard
  • enablePowerUp
  • makeAdminOfBoard
  • makeNormalMemberOfBoard
  • makeNormalMemberOfOrganization
  • makeObserverOfBoard
  • memberJoinedTrello
  • moveCardFromBoard
  • moveCardToBoard
  • moveListFromBoard
  • moveListToBoard
  • removeChecklistFromCard
  • removeFromOrganizationBoard
  • removeMemberFromCard
  • unconfirmedBoardInvitation
  • unconfirmedOrganizationInvitation
  • updateBoard
  • updateCard
  • updateCard:closed
  • updateCard:desc
  • updateCard:idList
  • updateCard:name
  • updateCheckItemStateOnCard
  • updateChecklist
  • updateList
  • updateList:closed
  • updateList:name
  • updateMember
  • updateOrganization

attachments

Default: false
Either a boolean value or cover for only cover attachments

attachment_fields

Default: all
all or a comma-separated list of:

  • bytes
  • date
  • edgeColor
  • idMember
  • isUpload
  • mimeType
  • name
  • previews
  • url

stickers

Default: false
One of: true, false

members

Default: false
One of: true, false

member_fields

Default: avatarHash,fullName,initials,username
all or a comma-separated list of:

  • avatarHash
  • bio
  • bioData
  • confirmed
  • fullName
  • idPremOrgsAdmin
  • initials
  • memberType
  • products
  • status
  • url
  • username

checkItemStates

Default: false
One of: true, false

checklists

Default: none
One of: all, none

limit

A number from 1 to 1000

since

A date, or null

before

A date, or null

filter

Default: visible
One of: all, closed, none, open, visible

fields

Default: all
all or a comma-separated list of:

  • badges
  • checkItemStates
  • closed
  • dateLastActivity
  • desc
  • descData
  • due
  • email
  • idAttachmentCover
  • idBoard
  • idChecklists
  • idLabels
  • idList
  • idMembers
  • idMembersVoted
  • idShort
  • labels
  • limits
  • manualCoverAttachment
  • name
  • pos
  • shortLink
  • shortUrl
  • subscribed
  • url

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

GET https://api.trello.com/1/lists/560bf44ea68b16bd0fc2a9a9/cards?fields=id,name,badges,labels
[
  {
    "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",
        "uses": 15
      }
    ]
  },
  {
    "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",
        "uses": 15
      }
    ]
  }
]
Suggest Edits

Attachments

 

Cards can have up to 100 attachments. Attachments can be either just URLs, images with previews, or arbitrary files.

id
string

The ID of the attachment

bytes
integer

The size of the attachment in bytes

date
date

The date the attachment was added

edgeColor
string

For image attachments, the extracted edge color

idMember
string

The ID of the member who attached the attachment

isUpload
boolean

Whether the attachment was uploaded

mimeType
string

The mimeType for the attachment

name
string

The name of the attachment

pos
float

The position of the attachment in the attachments list

previews
array of preview objects

If the image is an uploaded image, Trello will generate some various sized previews

url
string

The URL to the attachment

GET /1/cards/nqPiDKmw/attachments/5944a06460ed0bee471ad8e0

{
  "id": "5944a06460ed0bee471ad8e0",
  "bytes": 1351054,
  "date": "2017-06-17T03:22:12.489Z",
  "edgeColor": "#603e3d",
  "idMember": "556c8537a1928ba745504dd8",
  "isUpload": true,
  "mimeType": null,
  "name": "image.png",
  "previews": [
    {
      "bytes": 7093,
      "url": "https://trello-attachments.s3.amazonaws.com/560bf4dd7139286471dc009c/70x50/9a91dc761550dbbb658acaab6e82788f/image.png",
      "height": 50,
      "width": 70,
      "_id": "5944a06599fcb2710ea8a036",
      "scaled": false
    },
    {
      "bytes": 78708,
      "url": "https://trello-attachments.s3.amazonaws.com/560bf4dd7139286471dc009c/250x150/a871bc785b48830941b619299f29a29c/image.png",
      "height": 150,
      "width": 250,
      "_id": "5944a06599fcb2710ea8a035",
      "scaled": false
    },
    {
      "bytes": 29621,
      "url": "https://trello-attachments.s3.amazonaws.com/560bf4dd7139286471dc009c/150x85/1f6bfdb36d636cf33885459e5152842a/image.png",
      "height": 85,
      "width": 150,
      "_id": "5944a06599fcb2710ea8a034",
      "scaled": true
    },
    {
      "bytes": 111108,
      "url": "https://trello-attachments.s3.amazonaws.com/560bf4dd7139286471dc009c/300x170/7bf7c8551d3ed495e2872a342df529c8/image.png",
      "height": 170,
      "width": 300,
      "_id": "5944a06599fcb2710ea8a033",
      "scaled": true
    },
    {
      "bytes": 418182,
      "url": "https://trello-attachments.s3.amazonaws.com/560bf4dd7139286471dc009c/600x340/4fa1415ee1f63d7e0323a99cf9c4b070/image.png",
      "height": 340,
      "width": 600,
      "_id": "5944a06599fcb2710ea8a032",
      "scaled": true
    },
    {
      "bytes": 1351054,
      "height": 600,
      "width": 1060,
      "url": "https://trello-attachments.s3.amazonaws.com/560bf4298b3dda300c18d09c/560bf4dd7139286471dc009c/1d9626a92755602d80e42faeb2de1ef8/image.png",
      "_id": "5944a06599fcb2710ea8a031",
      "scaled": true
    }
  ],
  "url": "https://trello-attachments.s3.amazonaws.com/560bf4298b3dda300c18d09c/560bf4dd7139286471dc009c/1d9626a92755602d80e42faeb2de1ef8/image.png",
  "pos": 32768
}
 

Cards can have stickers applied to them.

id
string

The ID of the sticker

image
string

The name of the sticker if it is a default sticker or a generated id if it is a custom sticker

imageScaled
array of scaled image objects

An array of scaled versions of the sticker image

 {
  "width": 140,
  "height": 140,
  "url": "https://d2k1ftgv7pobq7.cloudfront.net/images/stickers/taco-alert.png",
  "scaled": false,
  "_id": "5951704b646dd188a3aabbf2"
}

imageUrl
string

Direct URL to the image

left
float

How far to the left of the card the sticker is placed

top
float

How far from the top of the card the sticker is placed

rotate
float

How much the sticker has been rotated

zIndex
integer

The ordering for display which tells you which sticker would show on top of another

GET /1/cards/nqX2Cl8w/stickers/5807bedf4e4d6ba6ca02039f

{
  "id": "5807bedf4e4d6ba6ca02039f",
  "top": 0,
  "left": 47.31,
  "zIndex": 1,
  "rotate": -7,
  "image": "taco-alert",
  "imageUrl": "https://d2k1ftgv7pobq7.cloudfront.net/images/stickers/taco-alert.png",
  "imageScaled": [
    {
      "width": 140,
      "height": 140,
      "url": "https://d2k1ftgv7pobq7.cloudfront.net/images/stickers/taco-alert.png",
      "scaled": false,
      "_id": "5951704b646dd188a3aabbf2"
    },
    {
      "width": 280,
      "height": 280,
      "url": "https://d2k1ftgv7pobq7.cloudfront.net/images/stickers/taco-alert@2x.png",
      "scaled": false,
      "_id": "5951704b646dd188a3aabbf1"
    }
  ]
}
Suggest Edits

/cards/{id}

Get a card by its ID

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id
curl --request GET \
  --url https://api.trello.com/1/cards/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

Query Params

fields
string

all or a comma-separated list of fields

actions
string
attachments
string

true, false, or cover

attachment_fields
string

all or a comma-separated list of attachment fields

members
boolean

Whether to return member objects for members on the card

member_fields
string

all or a comma-separated list of member fields

membersVoted
boolean

Whether to return member objects for members who voted on the card

memberVoted_fields
string

all or a comma-separated list of member fields

checkItemStates
boolean
checklists
string

Whether to return the checklists on the card. all or none

checklist_fields
string

all or a comma-separated list of idBoard,idCard,name,pos

board
boolean

Whether to return the board object the card is on

board_fields
string

all or a comma-separated list of board fields

list
boolean
pluginData
boolean

Whether to include pluginData on the card with the response

stickers
boolean

Whether to include sticker models with the response

sticker_fields
string

all or a comma-separated list of sticker fields

fields
string

all or a comma-separated list of card fields

 
https://api.trello.com/1/cards/SDmaAwz9
{
  "id": "58e800aa9ebaaa01c586f630",
  "badges": {
    "votes": 0,
    "viewingMemberVoted": false,
    "subscribed": false,
    "fogbugz": "",
    "checkItems": 0,
    "checkItemsChecked": 0,
    "comments": 0,
    "attachments": 1,
    "description": true,
    "due": null,
    "dueComplete": false
  },
  "checkItemStates": [
    
  ],
  "closed": false,
  "dateLastActivity": "2017-04-07T21:26:00.365Z",
  "desc": "Allows you to stay on top of the progress of any project by sending updates to Slack channels when activity occurs on Trello cards, lists, and boards. Customizable.\n\nRead more: http://blog.trello.com/slack-power-up-trello-alerts",
  "descData": {
    "emoji": {
      
    }
  },
  "due": null,
  "dueComplete": false,
  "email": "mattcowan+2k9ubwvzo7kk6xm8d08+2o19bzxhxca6rnhbq5s+1j517ulwv4@boards.trello.com",
  "idBoard": "4d5ea62fd76aa1136000000c",
  "idChecklists": [
    
  ],
  "idLabels": [
    
  ],
  "idList": "58e7fee3e06e4001f1cc3658",
  "idMembers": [
    
  ],
  "idShort": 1579,
  "idAttachmentCover": "58e801c30f51ca01a6dd6745",
  "manualCoverAttachment": false,
  "labels": [
    
  ],
  "name": "Trello Alerts for Slack",
  "pos": 131071,
  "shortUrl": "https://trello.com/c/SDmaAwz9",
  "url": "https://trello.com/c/SDmaAwz9/1579-trello-alerts-for-slack"
}
Suggest Edits

/cards/{id}/{field}

Get a specific property of a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/field
curl --request GET \
  --url https://api.trello.com/1/cards/id/field
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/field' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/field");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/field"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The id of the card

field
string
required

The desired field. One of fields

 

GET /1/cards/nqPiDKmw/name

{
  "_value": "Grand Canyon National Park"
}
Suggest Edits

/cards/{id}/actions

List the actions on a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/actions
curl --request GET \
  --url https://api.trello.com/1/cards/id/actions
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/actions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/actions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/actions");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/actions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

 

For all available query params, please see the Actions Nested Resource

For Example:

GET /1/cards/NIRpzVDM/actions?limit=5

[
  {
    "id": "561f43cf9ee2b14c75583e6e",
    "idMemberCreator": "561f394aeb6a4b033754060e",
    "data": {
      "list": {
        "name": "Info",
        "id": "53f4c48a94f780435b611ce9"
      },
      "board": {
        "shortLink": "nC8QJJoZ",
        "name": "Trello Development",
        "id": "4d5ea62fd76aa1136000000c"
      },
      "card": {
        "shortLink": "NIRpzVDM",
        "idShort": 1211,
        "name": "What can you expect from this board?",
        "id": "4f7dcc310113192a307f347d"
      },
      "text": "Looking Forward to new support`"
    },
    "type": "commentCard",
    "date": "2015-10-15T06:12:31.822Z",
    "memberCreator": {
      "id": "561f394aeb6a4b033754060e",
      "avatarHash": "f3d899950817ffcf32ca671cb793809d",
      "fullName": "Eric Chen",
      "initials": "EC",
      "username": "ericchen76"
    }
  },
  {
    "id": "5605799c5a1b485d054e1135",
    "idMemberCreator": "4e70297a9618260000001a81",
    "data": {
      "list": {
        "name": "Info",
        "id": "53f4c48a94f780435b611ce9"
      },
      "board": {
        "shortLink": "nC8QJJoZ",
        "name": "Trello Development",
        "id": "4d5ea62fd76aa1136000000c"
      },
      "card": {
        "shortLink": "NIRpzVDM",
        "idShort": 1211,
        "name": "What can you expect from this board?",
        "id": "4f7dcc310113192a307f347d"
      },
      "text": "This has probably come up before, but can we please have due dates for checklist items? "
    },
    "type": "commentCard",
    "date": "2015-09-25T16:43:08.158Z",
    "memberCreator": {
      "id": "4e70297a9618260000001a81",
      "avatarHash": "aaf480486554c8f329469e736f79420c",
      "fullName": "Ashish Bogawat",
      "initials": "AB",
      "username": "ashishbogawat"
    }
  },
  {
    "id": "560019007f0637ba5deda56a",
    "idMemberCreator": "4d713bcb37a18a4a1400697f",
    "data": {
      "list": {
        "name": "Info",
        "id": "53f4c48a94f780435b611ce9"
      },
      "board": {
        "shortLink": "nC8QJJoZ",
        "name": "Trello Development",
        "id": "4d5ea62fd76aa1136000000c"
      },
      "card": {
        "shortLink": "NIRpzVDM",
        "idShort": 1211,
        "name": "What can you expect from this board?",
        "id": "4f7dcc310113192a307f347d"
      },
      "text": "@constancedelgiudice I've been trying to keep this post up to date: http://trellostatus.tumblr.com/post/129567787933/investigating-delays-with-email-to-board"
    },
    "type": "commentCard",
    "date": "2015-09-21T14:49:36.534Z",
    "memberCreator": {
      "id": "4d713bcb37a18a4a1400697f",
      "avatarHash": "94527f5abac7de03a5ab541c14b49d11",
      "fullName": "Ben McCormack",
      "initials": "BRM",
      "username": "ben"
    }
  },
  {
    "id": "560015b435c347e254747ac0",
    "idMemberCreator": "55feef4242595b8ec2f5f197",
    "data": {
      "list": {
        "name": "Info",
        "id": "53f4c48a94f780435b611ce9"
      },
      "board": {
        "shortLink": "nC8QJJoZ",
        "name": "Trello Development",
        "id": "4d5ea62fd76aa1136000000c"
      },
      "card": {
        "shortLink": "NIRpzVDM",
        "idShort": 1211,
        "name": "What can you expect from this board?",
        "id": "4f7dcc310113192a307f347d"
      },
      "text": "Thank you so much for the quick responseโ€ฆ. I guess Iโ€™ll keep a look out for any news! \n\nConstance"
    },
    "type": "commentCard",
    "date": "2015-09-21T13:52:34.000Z",
    "memberCreator": {
      "id": "55feef4242595b8ec2f5f197",
      "avatarHash": "d7d8a3e2bf16941ea0b460d347017ae1",
      "fullName": "Constance DelGiudice",
      "initials": "CD",
      "username": "constancedelgiudice"
    }
  },
  {
    "id": "560007f1da47d319e30a2034",
    "idMemberCreator": "4d713bcb37a18a4a1400697f",
    "data": {
      "list": {
        "name": "Info",
        "id": "53f4c48a94f780435b611ce9"
      },
      "board": {
        "shortLink": "nC8QJJoZ",
        "name": "Trello Development",
        "id": "4d5ea62fd76aa1136000000c"
      },
      "card": {
        "shortLink": "NIRpzVDM",
        "idShort": 1211,
        "name": "What can you expect from this board?",
        "id": "4f7dcc310113192a307f347d"
      },
      "text": "@constancedelgiudice we're noticing the delays as well. We're reaching out to our email service provider to figure out what's happening."
    },
    "type": "commentCard",
    "date": "2015-09-21T13:36:49.216Z",
    "memberCreator": {
      "id": "4d713bcb37a18a4a1400697f",
      "avatarHash": "94527f5abac7de03a5ab541c14b49d11",
      "fullName": "Ben McCormack",
      "initials": "BRM",
      "username": "ben"
    }
  }
]
Suggest Edits

/cards/{id}/attachments

List the attachments on a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/attachments
curl --request GET \
  --url https://api.trello.com/1/cards/id/attachments
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/attachments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/attachments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/attachments");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/attachments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

fields
string
required

all or a comma-separated list of attachment fields

filter
string
required

Use cover to restrict to just the cover attachment

 
https://api.trello.com/1/cards/SDmaAwz9/attachments
[
  {
    "id": "58e801c30f51ca01a6dd6745",
    "bytes": 62103,
    "date": "2017-04-07T21:16:51.346Z",
    "edgeColor": "#f0e9f1",
    "idMember": "57f2789b32d54fa10d99beb6",
    "isUpload": true,
    "mimeType": null,
    "name": "Screen Shot 2017-04-07 at 5.14.55 PM.png",
    "previews": [
      {
        "bytes": 1811,
        "url": "https://trello-attachments.s3.amazonaws.com/58e800aa9ebaaa01c586f630/70x50/e5ef494a0044dd7cd6b73c19955c8cfa/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "height": 50,
        "width": 70,
        "_id": "58e801c4456b715c478e1e42",
        "scaled": false
      },
      {
        "bytes": 5285,
        "url": "https://trello-attachments.s3.amazonaws.com/58e800aa9ebaaa01c586f630/250x150/6d59fba20fe4a2c431129b3c300b95a5/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "height": 150,
        "width": 250,
        "_id": "58e801c4456b715c478e1e41",
        "scaled": false
      },
      {
        "bytes": 3431,
        "url": "https://trello-attachments.s3.amazonaws.com/58e800aa9ebaaa01c586f630/150x77/ed52a061abdb26c84059f91e084f74a8/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "height": 77,
        "width": 150,
        "_id": "58e801c4456b715c478e1e40",
        "scaled": true
      },
      {
        "bytes": 6229,
        "url": "https://trello-attachments.s3.amazonaws.com/58e800aa9ebaaa01c586f630/300x154/c467423c26881a5210aca243bf0254af/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "height": 154,
        "width": 300,
        "_id": "58e801c4456b715c478e1e3f",
        "scaled": true
      },
      {
        "bytes": 13359,
        "url": "https://trello-attachments.s3.amazonaws.com/58e800aa9ebaaa01c586f630/600x309/17f5babd64192bea9c29e96832bdc07f/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "height": 309,
        "width": 600,
        "_id": "58e801c4456b715c478e1e3e",
        "scaled": true
      },
      {
        "bytes": 35340,
        "url": "https://trello-attachments.s3.amazonaws.com/58e800aa9ebaaa01c586f630/1200x617/6ff057c7801890c126228ce1fd70337c/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "height": 617,
        "width": 1200,
        "_id": "58e801c4456b715c478e1e3d",
        "scaled": true
      },
      {
        "bytes": 62103,
        "height": 663,
        "width": 1289,
        "url": "https://trello-attachments.s3.amazonaws.com/4d5ea62fd76aa1136000000c/58e800aa9ebaaa01c586f630/1619f1fcd3065c9a2bccd318e9b7a154/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
        "_id": "58e801c4456b715c478e1e3c",
        "scaled": true
      }
    ],
    "url": "https://trello-attachments.s3.amazonaws.com/4d5ea62fd76aa1136000000c/58e800aa9ebaaa01c586f630/1619f1fcd3065c9a2bccd318e9b7a154/Screen_Shot_2017-04-07_at_5.14.55_PM.png",
    "pos": 16384
  }
]
Suggest Edits

/cards/{id}/attachments/{idAttachment}

Get a specific attachment on a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/attachments/idAttachment
curl --request GET \
  --url https://api.trello.com/1/cards/id/attachments/idAttachment
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/attachments/idAttachment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/attachments/idAttachment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/attachments/idAttachment");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/attachments/idAttachment"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

idAttachment
string
required

The ID of the attachment

Query Params

fields
string

all or a comma-separated list of attachment fields

 
Suggest Edits

/cards/{id}/board

Get the board a card is on

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/board
curl --request GET \
  --url https://api.trello.com/1/cards/id/board
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/board' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/board")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/board");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/board"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

Query Params

fields
string

all or a comma-separated list of board fields

 

GET /1/cards/560bf4dd7139286471dc009c/board

{
  "id": "560bf4298b3dda300c18d09c",
  "name": "US National Parks",
  "desc": "",
  "descData": null,
  "closed": false,
  "idOrganization": "577eb8850b41e08c3034aae2",
  "invited": false,
  "pinned": false,
  "starred": true,
  "url": "https://trello.com/b/tBmYPSYe/us-national-parks",
  "prefs": {
    "permissionLevel": "public",
    "voting": "disabled",
    "comments": "members",
    "invitations": "members",
    "selfJoin": true,
    "cardCovers": true,
    "cardAging": "regular",
    "calendarFeedEnabled": false,
    "background": "560bfbb5176d070c67adc2b9",
    "backgroundImage": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/1920x1080/b5ab43954a54880e455d3b4e5109644c/Bryce_Canyon.jpg",
    "backgroundImageScaled": [
      {
        "width": 140,
        "height": 100,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/140x100/cf6ffdfac5ecf934ec324bf028b82686/Bryce_Canyon.jpg"
      },
      {
        "width": 256,
        "height": 192,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/256x192/2189d1f2d6c159c7de210412cc0e971f/Bryce_Canyon.jpg"
      },
      {
        "width": 480,
        "height": 480,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/480x480/62bde347e629774a83378caf61f0fdb7/Bryce_Canyon.jpg"
      },
      {
        "width": 960,
        "height": 960,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/960x960/3102fa79837dfd37834cfaee02d1921c/Bryce_Canyon.jpg"
      },
      {
        "width": 1024,
        "height": 1024,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/1024x1024/53a50ede7425af0b02a7b9bde783fe94/Bryce_Canyon.jpg"
      },
      {
        "width": 1280,
        "height": 1280,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/1280x1280/491f54004976a4a81706caae613acf7f/Bryce_Canyon.jpg"
      },
      {
        "width": 1920,
        "height": 1080,
        "url": "https://trello-backgrounds.s3.amazonaws.com/556c8537a1928ba745504dd8/1920x1080/b5ab43954a54880e455d3b4e5109644c/Bryce_Canyon.jpg"
      }
    ],
    "backgroundTile": false,
    "backgroundBrightness": "light",
    "canBePublic": false,
    "canBeOrg": false,
    "canBePrivate": false,
    "canInvite": true
  },
  "invitations": [
    
  ],
  "memberships": [
    {
      "id": "560bf4298b3dda300c18d09d",
      "idMember": "556c8537a1928ba745504dd8",
      "memberType": "admin",
      "unconfirmed": false,
      "deactivated": false
    },
    {
      "id": "58ebc5d5abcedaf34a60800e",
      "idMember": "56fd3de8ba3cbeb22737fd55",
      "memberType": "normal",
      "unconfirmed": false,
      "deactivated": false
    }
  ],
  "shortLink": "tBmYPSYe",
  "subscribed": false,
  "labelNames": {
    "green": "Visited",
    "yellow": "",
    "orange": "",
    "red": "",
    "purple": "",
    "blue": "",
    "sky": "",
    "lime": "",
    "pink": "",
    "black": ""
  },
  "powerUps": [
    
  ],
  "dateLastActivity": "2017-06-26T17:39:49.583Z",
  "dateLastView": "2017-06-26T17:43:56.319Z",
  "shortUrl": "https://trello.com/b/tBmYPSYe",
  "idTags": [
    
  ],
  "datePluginDisable": null
}
Suggest Edits

/cards/{id}/checkItemStates

Get the completed checklist items on a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/checkItemStates
curl --request GET \
  --url https://api.trello.com/1/cards/id/checkItemStates
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/checkItemStates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/checkItemStates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/checkItemStates");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/checkItemStates"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

Query Params

fields
string

all or a comma-separated list of: idCheckItem, state

 

GET /1/cards/ndXbmEbO/checkItemStates

[
  {
    "idCheckItem": "5914b29abcbe09ab9478d156",
    "state": "complete"
  }
]
Suggest Edits

/cards/{id}/checklists

Get the checklists on a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/checklists
curl --request GET \
  --url https://api.trello.com/1/cards/id/checklists
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/checklists' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/checklists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.trello.com/1/cards/id/checklists");

xhr.send(data);
import requests

url = "https://api.trello.com/1/cards/id/checklists"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The ID of the card

Query Params

checkItems
string

all or none

checkItem_fields
string

all or a comma-separated list of: name,nameData,pos,state,type

filter
string

all or none

fields
string

all or a comma-separated list of: idBoard,idCard,name,pos

 

GET /1/cards/ndXbmEbO/checklists

[
  {
    "id": "5914b2923876e144b5cb6974",
    "name": "Awesomeness to come",
    "idBoard": "4d5ea62fd76aa1136000000c",
    "idCard": "5914b27920508fcb6bfd525f",
    "pos": 16384,
    "checkItems": [
      {
        "state": "complete",
        "idChecklist": "5914b2923876e144b5cb6974",
        "id": "5914b29abcbe09ab9478d156",
        "name": "Custom Fields in CSV exports",
        "nameData": null,
        "pos": 16867
      },
      {
        "state": "incomplete",
        "idChecklist": "5914b2923876e144b5cb6974",
        "id": "5914b2a1ee4421b88542b59a",
        "name": "Custom Fields on mobile",
        "nameData": null,
        "pos": 34254
      },
      {
        "state": "incomplete",
        "idChecklist": "5914b2923876e144b5cb6974",
        "id": "5914b2b2e01e5b17afedf6fc",
        "name": "Working well across multiple boards",
        "nameData": null,
        "pos": 51540
      }
    ]
  }
]
Suggest Edits

/cards/{id}/checkItem/{idCheckItem}

Get a specific checkItem on a card

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.trello.com/1/cards/id/checkItem/idCheckItem
curl --request GET \
  --url https://api.trello.com/1/cards/id/checkItem/idCheckItem
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.trello.com/1/cards/id/checkItem/idCheckItem' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.trello.com/1/cards/id/checkItem/idCheckItem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::