Trello

Trello

Trello gives you perspective over all your projects, at work and at home. It is an easy, free, flexible, and visual way to manage your projects and organize anything. Connect to Trello to manage your boards, lists and cards.

Actions

A simple version of list cards

A simple version of list cards to be used by dynamic values.

Required Parameters

Board Id
string
Unique Id of the board to fetch lists

Returns

array of List

A simple version of the list boards

A simple version of the list boards API call with no parameters to be used by dynamic values.

Required Parameters

Board Id
string
Unique Id of the board to fetch lists

Returns

array of Board

A simple version of the list cards

A simple version of the list cards API method used by dynamic values.

Required Parameters

Board Id
string
Board Id

Returns

array of Card

Add a comment to a card

Add a comment to a specific card.

Required Parameters

Board Id
string
The unique id of the board to add a comment to.
Card Id
string
The unique id of the card.

Optional Parameters

Comment Text
string
The text of the comment.

Returns

Body
Comment

The model for getting a comment

Add member to a card

Add a member to a specific card.

Required Parameters

Board Id
string
The unique id of the board the card is on.
Card Id
string
The unique identifier of the card to add a member to.
Member Id or Username
string
The member id or username to add to the card.

Returns

array of Member

Close a board

Set a specific board to closed.

Required Parameters

Board Id
string
The unique id of the board to close.

Returns

Body
Board

A Trello Board Object

Create a board

Create a new board with the specified fields.

Required Parameters

Board Name
string
The name of the board.

Optional Parameters

Create Default Lists
string
A string (true, false) determining whether or not to create default lists.
Board Description
string
The description of the board.
Team Id
string
The id of the team.
Permission Level
string
The permission level of the board. Valid options are 'org', 'private', or 'public'.
Comment Preferences
string
The comment preferences of the board.
Invitation Preferences
string
The invitation preferences of the board.
Use Card Covers
string
A string (true, false) determining whether or not to use card covers.
Background Color
string
The background color of the board.
Voting Power-up Preferences
string
The voting power-up preferences of the board.
Card Aging Power-up Preferences
string
The card aging power-up preferences of the board.
Enable Calendar Power-up
string
A string (true, false) determining whether or not to enable calendar power-up.

Returns

Body
Board

A Trello Board Object

Create a card

Creates a new card with the parameters provided.

Required Parameters

Board Id
string
The id of the board to create the card in.
Parent List Id
string
The id of the list that the card should be added to.
Card Name
string
The name of the new card.

Optional Parameters

Card Description
string
The description of the new card.
Card Position
string
The position of the card. Specify top, bottom, or a positive number. Note this is used in relation to existing card locations so the resulting location may not match the exact value provided.
Member Id
string
A comma seperated list of member Ids to attach to the card.
Label Id
string
A comma-separated list of labels Ids to attach to the card.
Source Url
string
Source url of the card. Has to be a URL starting with http:// or https:// or null.
Source File
string
Source file of the card.
Source Card Id
string
The Id of the card to copy into a new card.
Properties From Source Card
string
Properties of the card to copy over from the source.
Due Date
string
The due date of the card.

Returns

array of List

Create a list

Create a new list.

Required Parameters

List Name
string
The name of the list.
Board Id
string
The unique Id of the board to create the list in.

Optional Parameters

List Position
string
The position of the list. Specify top, bottom, or a positive number.
List Source
string
The id of the list to copy into the new list.

Returns

Body
CreateListResponse

A Trello List Object

Delete a card

Delete an existing card from the account.

Required Parameters

Board Id
string
The id of the board to fetch cards from.
Card Id
string
The id of the card to delete.

Returns

array of List

Get a board by Id

Get a specific board by its unique identifier.

Required Parameters

Board Id
string
The unique Id of the board to get.

Optional Parameters

Actions
string
List the actions to return. Specify 'all' or a comma seperated list of valid values.
Action Entities
boolean
A boolean value (true, false) determining whether or not to return action entities.
Actions Display
boolean
A boolean value (true, false) determining whether or not to return actions display.
Actions Format
string
Specify the format of the actions to return. Valid options are 'count = null', 'list = null', 'minimal'.
Actions Since
date-time
Only return the actions after this date.
Actions Limit
integer
Max number of actions to return.
Action Field
string
List the fields to return with each field. Specify 'all' or a comma seperated list of valid values.
Action Member
boolean
A boolean value (true, false) determining whether or not to return action members.
Action Member Fields
string
List the member fields to return with each action member. Specify 'all' or a comma seperated list of valid values.
Action Member Creator
boolean
A boolean value (true, false) determining whether or not to return action member creator.
Action Member Creator Fields
string
List the action member creator fields to return. Specify 'all' or a comma seperated list of valid values.
Cards
string
Specify the cards to return. Valid options are 'all = null', 'closed = null', 'none = null', 'open = null', or 'visible'.
Card Fields
string
List the fields to return for each card. Specify 'all' or a comma seperated list of valid values.
Card Attachments
boolean
A boolean value (true, false) determining whether or not to return attachments on cards.
Card Attachment Fields
string
List the attachment fields to return for each attachment. Specify 'all' or a comma seperated list of valid values.
Card Checklists
string
Specify the checklists to return for each card.
Card Stickers
boolean
A boolean value (true, false) determining whether or not to return card stickers.
Board Stars
string
Specify the board stars to return.
Labels
string
Specify the labels to return.
Label Fields
string
List the label fields to return for each label. Specify 'all' or a comma seperated list of valid values.
Label Limits
integer
Max number of labels to return.
Lists
string
Specify the lists to return.
List Fields
string
List the list fields to return for each list. Specify 'all' or a comma seperated list of valid values.
Memberships
string
List the memberships to return. Specify 'all' or a comma seperated list of valid values.
Memberships Member
boolean
A boolean value (true, false) determining whether or not to return membership members.
Memberships Member Fields
string
List the member fields to return for each membership member. Specify 'all' or a comma seperated list of valid values.
Members
string
List the members to return. Specify 'all' or a comma seperated list of valid values.
Member Fields
string
List the member fields to return for each member. Specify 'all' or a comma seperated list of valid values.
Invited Members
string
Specify the invited members to return.
Invited Member Fields
string
List the fields to return for each. Specify 'all' or a comma seperated list of valid values.
Checklists
string
Specify the checklists to return.
Checklist Fields
string
List the checklist fields to return for each checklist. Specify 'all' or a comma seperated list of valid values.
Organization
boolean
A boolean value (true, false) determining whether or not to return the organization information.
Organization Fields
string
List the organization fields to return for each organization. Specify 'all' or a comma seperated list of valid values.
Organization Memberships
string
List the organization memberships to return. Specify 'all' or a comma seperated list of valid values.
My perfs
boolean
A boolean value (true, false) determining whether or not to return my perfs.
Fields
string
List the fields to return. Specify 'all' or a comma seperated list of valid values.

Returns

Body
Board

A Trello Board Object

Get a card by id

Get a specific card by its unique id.

Required Parameters

Board Id
string
The id of the board to fetch cards in.
Card Id
string
The id of the card to fetch.

Optional Parameters

Actions
string
List the actions to return. Specify 'all' or a comma seperated list of valid values.
Actions Entities
boolean
A boolean value (true, false) determining whether or not to return action entities.
Actions Display
boolean
A boolean value (true, false) determining whether or not to return action displays.
Actions Limit
integer
Max number of actions to return.
Action Fields
string
List of action fields to return for each action. Specify 'all' or a comma seperated list of valid values.
Member Creator Action Fields
string
List of action member creator fields to return. Specify 'all' or a comma seperated list of valid values.
Attachments
boolean
A boolean value (true, false) determining whether or not to return attachments.
Attachments Fields
string
List of attachment fields to return for each attachment. Specify 'all' or a comma seperated list of valid values.
Members
boolean
A boolean value (true, false) determining whether or not to return members.
Member Fields
string
List of member fields to return for each member. Specify 'all' or a comma seperated list of valid values.
Voted Members
boolean
A boolean value (true, false) determining whether or not to return voted members.
Voted Member Fields
string
List of voted member fields to return for each voted member. Specify 'all' or a comma seperated list of valid values.
Check Item States
boolean
A boolean value (true, false) determining whether or not to return card states.
Item State Fields
string
List of state fields to return for each of the card item state. Specify 'all' or a comma seperated list of valid values.
Checklists
string
A boolean value (true, false) determining whether or not to return checklists.
Checklist Fields
string
List of checklist fields to return for each checklist. Specify 'all' or a comma seperated list of valid values.
Board
boolean
A boolean value (true, false) determining whether or not to return the board which the card belongs to.
Board Fields
string
List the board fields to return. Specify 'all' or a comma seperated list of valid values.
List
boolean
A boolean value (true, false) determining whether or not to return the list which the card belongs to.
List Fields
string
List the list fields to return. Specify 'all' or a comma seperated list of valid values.
Stickers
boolean
A boolean value (true, false) determining whether or not to return the stickers.
Sticker Fields
string
List the sticker fields to return for each sticker. Specify 'all' or a comma seperated list of valid values.
Fields
string
List the card fields to return.

Returns

Body
Card

A Trello Card Object

Get list by Id

Get an existing list and the cards in the list by the unique identifier of the list.

Required Parameters

Board Id
string
The unique Id of the board to fetch the lists from.
List Id
string
The unique Id of the list to fetch.

Optional Parameters

Cards
string
Specify the cards to return.
Card Fields
string
List the card fields to return for each card. Specify 'all' or a comma seperated list of valid values.
Board
boolean
A boolean value (true, false) determining whether or not to return board information.
Board Fields
string
List the board fields to return. Specify 'all' or a comma seperated list of valid values.
List Fields
string
List the list fields to return. Specify 'all' or a comma seperated list of valid values.

Returns

Body
List

A Trello List Object

Get the team for a board

Get the team details for a specific board.

Required Parameters

Board Id
string
The unique Id of the board to fetch team.

Returns

Body
Team

A Trello Team

List boards

List the boards matching the specified query parameters.

Optional Parameters

Filter
string
List filters to apply to board results. Specify 'all' or a comma seperated list of valid values.
Fields
string
List the board fields to return. Specify 'all' or a comma seperated list of valid values.
Actions
string
List the action fields to return. Specify 'all' or a comma seperated list of valid values.
Action Entities
boolean
A boolean value (true, false) determining whether or not to return action entities.
Action Limit
integer
The max number of actions to return.
Actions Format
string
Specify the format of the actions to return. The valid options are 'count', 'list', 'minimal'.
Actions Since
date-time
Return actions after the specified date.
Action Fields
string
List the fields of the action to return. Specify 'all' or a comma seperated list of valid values.
Memberships
string
Specify membership information to return.
Organization
boolean
A boolean value (true, false) determining whether or not to return organization information.
Organization Fields
string
List the organization fields to return. Specify 'all' or a comma seperated list of valid values.
Lists
string
Specify whether to return lists which belong to the board.

Returns

array of Board

List comments for a card

List the comments for a specific card.

Required Parameters

Board Id
string
The unique id of the board to look for comments on.
Card Id
string
The unique id of the card.

Returns

array of Comment

List members for a card

List the members for a specific card.

Required Parameters

Board Id
string
The unique id of the board to look for cards on.
Card Id
string
The unique id of the card.

Returns

array of Member

List members of a board

List the members of a specific board.

Required Parameters

Board Id
string
The unique Id of the board.

Returns

array of Member

List members of a team

List the members in a specific team.

Required Parameters

Team Id
string
The unique Id of the team.

Returns

array of Member

List teams you are a member of

The list of teams or organizations the account is a member of.

Required Parameters

Board Id
string
Unique Id of the board to fetch lists

Returns

array of Team

List the card lists in a board

List the card lists and the cards within the list in a specific board.

Required Parameters

Board Id
string
The unique id of the board to fetch lists.

Optional Parameters

Cards
string
Specify the cards to return.
Card Fields
string
List the card fields to return from. Specify 'all' or a comma seperated list of valid values.
Filter
string
Specify the filter property for lists. Valid options are 'all, 'closed', 'none', or 'open'.
Fields
string
List the fields to return. Specify 'all' or a comma seperated list of valid values.

Returns

array of List

List the cards in a board

List the cards matching the query parameters in a specific board.

Required Parameters

Board Id
string
The unique id of the board.

Optional Parameters

Actions
string
The list the actions to return. Specify 'all' or a comma seperated list of valid values.
Attachments
boolean
A boolean value (true, false) determining whether or not to show attachments.
Attachment Fields
string
List the attachment fields to return. Specify 'all' or a comma seperated list of valid values.
Stickers
boolean
A boolean value (true, false) determining whether or not to show stickers.
Members
boolean
A boolean value (true, false) determining whether or not to show members.
Member Fields
string
List the member fields to return. Specify 'all' or a comma seperated list of valid values.
Check Card States
boolean
A boolean value (true, false) determining whether or not to return the card states.
Checklists
string
A boolean value (true, false) determining whether or not to show checklists.
Limit
integer
The max number of results to return, between 1 and 1000.
Limit
date-time
Fetch all cards after this date.
Before
date-time
Fetch all cards before this date.
Filter
string
An option on how to filter the response. The allowed values are 'all', 'closed', 'none', 'open' or 'visible'.
Fields
string
List the card fields to return. Specify 'all' or a comma seperated list of valid values.

Returns

array of Card

Update a board

Update an existing board.

Required Parameters

Board Id
string
The unique identifier of the board to update.

Optional Parameters

Board Name
string
The name of the board.
Create Default Lists
string
A string (true, false) determining whether or not to create default lists.
Board Description
string
The description of the board.
Team Id
string
The id of the team.
Permission Level
string
The permission level of the board.
Comment Preferences
string
The comment preferences on the board. Valid options are 'disabled', 'members', 'observers', 'org' or 'public'.
Invitation Preferences
string
The invitation preferences of the board. Valid options are 'admins' or 'members'.
Use Card Covers
string
A string (true, false) determining whether or not to use card covers.
Background Color
string
The background color of the board.
Voting Power-up Preferences
string
The voting power-up preferences of the board.
Card Aging Power-up Preferences
string
The card aging power-up preferences of the board.
Enable Calendar Power-up
string
A string (true, false) determining whether or not to enable calendar power-up

Returns

Body
Board

A Trello Board Object

Update a card

Update an existing card with new parameters.

Required Parameters

Board id
string
The id of the board to fetch cards from.
Card id
string
The id of the card to update.
Name
string
The updated name of the new card.

Optional Parameters

Description
string
The updated description of the new card.
Is Closed
boolean
A boolean value (true, false) determining whether or not the card is closed.
Member Ids
string
The id of the members to add to the card.
Cover attachment Ids
string
The id of the attachemnt to attach to the card.
Board Id
string
The id of the board to attach the card to.
List Id
string
The id of the list to attach the card to.
Position
string
The position of the card on the page. Specify top, bottom, or a positive number. Note this is used in relation to existing card locations so the resulting location may not match the exact value provided.
Due Date
string
The due date of the card.
Subscribed To Card
boolean
A boolean value (true, false) determining whether or not to subscribe to the card.

Returns

Body
Card

A Trello Card Object

Update a list

Update an existing list.

Required Parameters

Board Id
string
The unique id of the board the list is on.
List Id
string
The unique id of the list to update.

Optional Parameters

List Name
string
The new list name.
Closed
string
A string (true, false) determining whether or not to close the list.
Board to move to
string
The unique id of the board to move the list to.
List Position
string
The list position (top, bottom, or number).
Subscribed
string
A boolean value (true, false) determining whether or not to subscribe to the list.

Returns

Body
CreateList

A Trello List Object

Triggers

When a new card is added to a board

Triggers a flow when a new card is added to a board.

Required Parameters

Board Id
string
The unique id of the board.

Returns

Body
Card

A Trello Card Object

When a new card is added to a list

Triggers a flow when a new card is added to a list.

Required Parameters

Board Id
string
The unique id of the board.
List Id
string
The unique id of the list in the specified board.

Returns

Body
Card

A Trello Card Object

Definitions

Card

A Trello Card Object

Attachment Cover Id
string
The unique Id of the attachment cover.
Board Id
string
The unique Id of the board which the card belongs to.
Card Description
string
The description of the card.
Card Due Date
date-time
The due date of the card.
Card Full Url
string
The full url to the card.
Card Id
string
The unique id of the card.
Card Name
string
The name of the card.
Card Position
integer
The position of the card.
Card Short Id
integer
The short Id of the card.
Card Short Link
string
A short link to the card.
Card Short Url
string
The short url link to the card.
Card closed
boolean
A boolean value (true, false) determining whether or not the card is closed.
Check Item States
array of string
The check item states in the card.
Is Manual Cover Attachment
boolean
A boolean value (true, false) determining whether or not the card has a manual cover attachment.
Is Subscribed
boolean
A boolean value (true, false) determining whether or not the card is subscribed to.
Label Ids
array of string
A list of label Ids on the card.
Last Activity Date
date-time
The datetime of last activity on the card.
List Id
string
The unique Id of the list which the card belongs to.
Voted Member Ids
array of string
The unique Ids of the voting members.
badges
Badges
A Trello Badges Object

Badges

A Trello Badges Object

Attachments
integer
The attachments on the badge.
Check Items
integer
The number of check items in the badge.
Checked Check Items
integer
The number of checked check items in the badge.
Comments
integer
The comments on the badge.
Description
boolean
The description of the badge.
Due Date
date-time
The due date of the badge.
Fogbugz
string
The fogbugz of the badges.
Subsribed To Badge
boolean
A boolean value (true, false) determining whether or not the account is subscribed to the card badges.
Viewing Member Voted
boolean
A boolean value (true, false) determining whether or not viewing members voted on the badge.
Votes
integer
The number of votes on the card badges.

Board

A Trello Board Object

Board Description
string
The description of the board.
Board Id
string
The unique Id of the board.
Board Memberships
array of Membership
The set of board memberships.
Board Name
string
The name of the board.
Board Short Link
string
The short link of the board.
Board Short Url
string
The short url to the board.
Board Url
string
The full url of the board.
Invitations
array of string
The list of invitations on the board.
Invited
boolean
A boolean value (true, false) determining whether or not the account is invited to the board.
Is Board Pinned
boolean
A boolean value (true, false) determining whether or not the board is pinned.
Is Closed
boolean
A boolean value (true, false) determining whether or not the board is closed.
Is Starred
string
A value determining whether or not the board is starred.
Last Activity Date
date-time
Date of the last activity on the board.
Last Viewed Date
date-time
Date of the last time the board is viewed.
Organization Id
string
The id of the organization.
Powerups
array of string
The set of power ups on the board.
Subscribed To Board
string
A value determining whether or not the account is subscribed to the board.
labelNames
Label
A Trello Label Object
perfs
Perfs
A Trello Perfs Object

Label

A Trello Label Object

Black Label
string
The value of the black label.
Blue Label
string
The value of the blue label.
Green Label
string
The value of the green label.
Lime Green Label
string
The value of the lime green label.
Orange Label
string
The value of the orange label.
Pink Label
string
The value of the pink label.
Purple Label
string
The value of the purple label.
Red Label
string
The value of the red label.
Sky Blue Label
string
The value of the sky blue label.
Yellow Label
string
The value of the yellow label.

Membership

A Trello Membership Object

Member Id
string
The unique Id of the member.
Member type
string
The type of member.
Membership Id
string
The unique Id of the membership.
Unconfirmed Membership
boolean
A boolean value (true, false) determining whether or not the membership is unconfirmed.

Perfs

A Trello Perfs Object

Background Brightness
string
The brightness of the object background.
Can Access Card Covers
boolean
A boolean value (true, false) determining whether or not the object has access to card covers.
Can Invite
boolean
A boolean value (true, false) determining whether or not the object can have invititations.
Can Object be Private
boolean
A boolean value (true, false) determining whether or not the object can be private.
Can Object be Public
boolean
A boolean value (true, false) determining whether or not the object can be public.
Can be Part of Organization
boolean
A boolean value (true, false) determining whether or not the object can be part of the organization
Commenting Permission
string
Who can comment on the object.
Invitation Permission
string
Who can invite people to the object.
Is Calendar Feed Enabled
boolean
A boolean value (true, false) determining whether or not the calendar feed enabled.
Object Background
string
The background of the object.
Object Background Color
string
The background color of the object, in hex notation.
Object Background Image
string
The background image of the object.
Object Background Tile
boolean
The background tile of the object.
Permission Level
string
The permission level of the object.
Scaled Backgorund Image
string
The scaled version of the background image.
Self Join Permission
boolean
A boolean value (true, false) determining whether or not the object can self join.
Voting Permission
string
Who can vote on the object.

List

A Trello List Object

Board Id
string
The unique Id of the board which the list belongs to.
Cards In List
array of Card
The cards inside the list.
Is Closed
boolean
A boolean value (true, false) determining whether or not the list is closed.
Is List Subscribed To
boolean
A boolean value (true, false) determining whether or not to the account is subscribed to the list.
List Id
string
The unique Id of the list.
List Name
string
The name of the list.
List Position
double
The position of the list.
board
Board
A Trello Board Object

CreateList

A Trello List Object

Board Id
string
The unique Id of the board to create the list in.
List Name
string
The name of the list.
List Position
string
The position of the list. Specify top, bottom, or a positive number.
List Source
string
The id of the list to copy into the new list.

Team

A Trello Team

Board Ids
array of string
The boards assigned to this team.
Member Count
integer
The number of members in this team.
Memberships
array of Membership
The memberships for this team.
Team Description
string
The description of the team.
Team Display Name
string
The display name of the team.
Team Id
string
The unique ID of the team.
Website
string
The team website.
prefs
TeamPreferences
A Trello Team Preference Object

TeamPreferences

A Trello Team Preference Object

Permission Level
string
The permission level of the team.

Member

A Trello Member Object

Full Name
string
The full name of the member.
Initials
string
The initials of the member.
Member Id
string
The unique Id of the member.
Username
string
The username of the member.

Comment

The model for getting a comment

Comment Text
string
The text of the comment.
Datetime Created
date-time
The datetime the comment was left.
memberCreator
Member
A Trello Member Object

CreateListResponse

A Trello List Object

Board Id
string
The unique Id of the board the list belongs to.
List Id
string
The unique Id of the list.
List Name
string
The name of the list.
List Position
string
The position of the list.

Limits

NameCallsRenewal Period
Frequency of trigger polls115 seconds