Connectors Reference

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.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListCards (string board_id, [advanced][Optional]string actions, [advanced][Optional]boolean attachments, [advanced][Optional]string attachment_fields, [advanced][Optional]boolean stickers, [advanced][Optional]boolean members, [advanced][Optional]string memeber_fields, [advanced][Optional]boolean CheckItemStates, [advanced][Optional]string Checklists, [advanced][Optional]integer limit, [advanced][Optional]string since, [advanced][Optional]string before, [advanced][Optional]string filter, [advanced][Optional]string fields)

List the cards in a board

ListCardsSimple (string board_id)

A simple version of the list cards

GetCard (string board_id, string card_id, [advanced][Optional]string actions, [advanced][Optional]boolean actions_entities, [advanced][Optional]boolean actions_display, [advanced][Optional]integer actions_limit, [advanced][Optional]string action_fields, [advanced][Optional]string action_memberCreator_fields, [advanced][Optional]boolean attachments, [advanced][Optional]string attachement_fields, [advanced][Optional]boolean members, [advanced][Optional]string member_fields, [advanced][Optional]boolean membersVoted, [advanced][Optional]string memberVoted_fields, [advanced][Optional]boolean checkItemStates, [advanced][Optional]string checkItemState_fields, [advanced][Optional]string checklists, [advanced][Optional]string checklist_fields, [advanced][Optional]boolean board, [advanced][Optional]string board_fields, [advanced][Optional]boolean list, [advanced][Optional]string list_fields, [advanced][Optional]boolean stickers, [advanced][Optional]string sticker_fields, [advanced][Optional]string fields)

Get a card by id

UpdateCard (string board_id, string card_id, UpdateCard updateCard)

Update a card

DeleteCard (string board_id, string card_id)

Delete a card

CreateCard (string board_id, CreateCard newCard)

Create a card

ListBoards ([advanced][Optional]string filter, [advanced][Optional]string fields, [advanced][Optional]string actions, [advanced][Optional]boolean actions_entities, [advanced][Optional]integer actions_limit, [advanced][Optional]string actions_format, [advanced][Optional]string actions_since, [advanced][Optional]string action_fields, [advanced][Optional]string memberships, [advanced][Optional]boolean organization, [advanced][Optional]string organization_fields, [advanced][Optional]string lists)

List boards

ListBoardsSimple ()

A simple version of the list boards

GetBoard (string board_id, [advanced][Optional]string actions, [advanced][Optional]boolean action_entities, [advanced][Optional]boolean actions_display, [advanced][Optional]string actions_format, [advanced][Optional]string actions_since, [advanced][Optional]integer actions_limit, [advanced][Optional]string action_fields, [advanced][Optional]boolean action_memeber, [advanced][Optional]string action_member_fields, [advanced][Optional]boolean action_memberCreator, [advanced][Optional]string action_memberCreator_fields, [advanced][Optional]string cards, [advanced][Optional]string card_fields, [advanced][Optional]boolean card_attachments, [advanced][Optional]string card_attachment_fields, [advanced][Optional]string card_checklists, [advanced][Optional]boolean card_stickers, [advanced][Optional]string boardStarts, [advanced][Optional]string labels, [advanced][Optional]string label_fields, [advanced][Optional]integer labels_limits, [advanced][Optional]string lists, [advanced][Optional]string list_fields, [advanced][Optional]string memberships, [advanced][Optional]boolean memberships_member, [advanced][Optional]string memberships_member_fields, [advanced][Optional]string members, [advanced][Optional]string member_fields, [advanced][Optional]string membersInvited, [advanced][Optional]string membersInvited_fields, [advanced][Optional]string checklists, [advanced][Optional]string checklist_fields, [advanced][Optional]boolean organization, [advanced][Optional]string organization_fields, [advanced][Optional]string organization_memberships, [advanced][Optional]boolean myPerfs, [advanced][Optional]string fields)

Get a board by Id

UpdateBoard (string board_id, [Optional]UpdateBoard board)

Update a board

ListLists (string board_id, [advanced][Optional]string cards, [advanced][Optional]string card_fields, [advanced][Optional]string filter, [advanced][Optional]string fields)

List the card lists in a board

ListListsSimple (string board_id)

A simple version of list cards

GetList (string board_id, string list_id, [advanced][Optional]string cards, [advanced][Optional]string card_fields, [advanced][Optional]boolean board, [advanced][Optional]string board_fields, [advanced][Optional]string fields)

Get list by Id

UpdateList (string board_id, string list_id, [Optional]string name, [advanced][Optional]string closed, [advanced][Optional]string idBoard, [advanced][Optional]string pos, [advanced][Optional]string subscribed)

Update a list

ListTeams ()

List teams you are a member of

ListTeamMembers (string teamId)

List members of a team

ListBoardMembers (string board_id)

List members of a board

GetTeamForBoard (string board_id)

Get the team for a board

ListCardMembers (string board_id, string card_id)

List members for a card

ListCardComments (string board_id, string card_id)

List comments for a card

AddCommentToCard (string board_id, string card_id, CommentPost comment)

Add a comment to a card

AddMemberToCard (string board_id, string cardId, string memberId)

Add member to a card

CreateBoard (CreateBoard board)

Create a board

CreateList (CreateList list)

Create a list

CloseBoard (string board_id)

Close a board

 

Triggers:

Name

Summary

OnNewCardInBoard (string board_id)

When a new card is added to a board

OnNewCardInList (string board_id, string list_id)

When a new card is added to a list

 

Objects:

Name

Summary

Badges

 

Board

 

Card

 

Comment

 

CommentPost

 

CreateBoard

 

CreateCard

 

CreateList

 

CreateListResponse

 

Label

 

List

 

Member

 

Membership

 

Object

 

Perfs

 

Team

 

TeamPreferences

 

UpdateBoard

 

UpdateCard

 

 

Actions:

ListCards

Summary: List the cards in a board

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

 

Syntax:

Trello.ListCards (string board_id, [advanced][Optional]string actions, [advanced][Optional]boolean attachments, [advanced][Optional]string attachment_fields, [advanced][Optional]boolean stickers, [advanced][Optional]boolean members, [advanced][Optional]string memeber_fields, [advanced][Optional]boolean CheckItemStates, [advanced][Optional]string Checklists, [advanced][Optional]integer limit, [advanced][Optional]string since, [advanced][Optional]string before, [advanced][Optional]string filter, [advanced][Optional]string fields)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board.

True

ListBoardsSimple

actions

string

(Actions)

The list the actions to return. Specify 'all' or a comma seperated list of valid values.

False

attachments

boolean

(Attachments)

A boolean value (true, false) determining whether or not to show attachments.

False

attachment_fields

string

(Attachment Fields)

List the attachment fields to return. Specify 'all' or a comma seperated list of valid values.

False

stickers

boolean

(Stickers)

A boolean value (true, false) determining whether or not to show stickers.

False

members

boolean

(Members)

A boolean value (true, false) determining whether or not to show members.

False

memeber_fields

string

(Member Fields)

List the member fields to return. Specify 'all' or a comma seperated list of valid values.

False

CheckItemStates

boolean

(Check Card States)

A boolean value (true, false) determining whether or not to return the card states.

False

Checklists

string

(Checklists)Values: [all, none]

A boolean value (true, false) determining whether or not to show checklists.

False

limit

integer(int32)

(Limit)

The max number of results to return, between 1 and 1000.

False

since

string(date-time)

(Limit)

Fetch all cards after this date.

False

before

string(date-time)

(Before)

Fetch all cards before this date.

False

filter

string

(Filter)Values: [all, closed, none, open, visible]

An option on how to filter the response. The allowed values are 'all', 'closed', 'none', 'open' or 'visible'.

False

fields

string

(Fields)

List the card fields to return. Specify 'all' or a comma seperated list of valid values.

False

 

Returns:

          Type:array of (Card)

 

ListCardsSimple

Summary: A simple version of the list cards

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

 

Syntax:

Trello.ListCardsSimple (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

Board Id

True

ListBoardsSimple

 

Returns:

          Type:array of (Card)

 

GetCard

Summary: Get a card by id

Description: Get a specific card by its unique id.

 

Syntax:

Trello.GetCard (string board_id, string card_id, [advanced][Optional]string actions, [advanced][Optional]boolean actions_entities, [advanced][Optional]boolean actions_display, [advanced][Optional]integer actions_limit, [advanced][Optional]string action_fields, [advanced][Optional]string action_memberCreator_fields, [advanced][Optional]boolean attachments, [advanced][Optional]string attachement_fields, [advanced][Optional]boolean members, [advanced][Optional]string member_fields, [advanced][Optional]boolean membersVoted, [advanced][Optional]string memberVoted_fields, [advanced][Optional]boolean checkItemStates, [advanced][Optional]string checkItemState_fields, [advanced][Optional]string checklists, [advanced][Optional]string checklist_fields, [advanced][Optional]boolean board, [advanced][Optional]string board_fields, [advanced][Optional]boolean list, [advanced][Optional]string list_fields, [advanced][Optional]boolean stickers, [advanced][Optional]string sticker_fields, [advanced][Optional]string fields)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The id of the board to fetch cards in.

True

ListBoardsSimple

card_id

string

(Card Id)

The id of the card to fetch.

True

ListCardsSimple

actions

string

(Actions)

List the actions to return. Specify 'all' or a comma seperated list of valid values.

False

actions_entities

boolean

(Actions Entities)

A boolean value (true, false) determining whether or not to return action entities.

False

actions_display

boolean

(Actions Display)

A boolean value (true, false) determining whether or not to return action displays.

False

actions_limit

integer(int32)

(Actions Limit)

Max number of actions to return.

False

action_fields

string

(Action Fields)

List of action fields to return for each action. Specify 'all' or a comma seperated list of valid values.

False

action_memberCreator_fields

string

(Member Creator Action Fields)

List of action member creator fields to return. Specify 'all' or a comma seperated list of valid values.

False

attachments

boolean

(Attachments)

A boolean value (true, false) determining whether or not to return attachments.

False

attachement_fields

string

(Attachments Fields)

List of attachment fields to return for each attachment. Specify 'all' or a comma seperated list of valid values.

False

members

boolean

(Members)

A boolean value (true, false) determining whether or not to return members.

False

member_fields

string

(Member Fields)

List of member fields to return for each member. Specify 'all' or a comma seperated list of valid values.

False

membersVoted

boolean

(Voted Members)

A boolean value (true, false) determining whether or not to return voted members.

False

memberVoted_fields

string

(Voted Member Fields)

List of voted member fields to return for each voted member. Specify 'all' or a comma seperated list of valid values.

False

checkItemStates

boolean

(Check Item States)

A boolean value (true, false) determining whether or not to return card states.

False

checkItemState_fields

string

(Item State Fields)

List of state fields to return for each of the card item state. Specify 'all' or a comma seperated list of valid values.

False

checklists

string

(Checklists)Values: [all = null, none]

A boolean value (true, false) determining whether or not to return checklists.

False

checklist_fields

string

(Checklist Fields)

List of checklist fields to return for each checklist. Specify 'all' or a comma seperated list of valid values.

False

board

boolean

(Board)

A boolean value (true, false) determining whether or not to return the board which the card belongs to.

False

board_fields

string

(Board Fields)

List the board fields to return. Specify 'all' or a comma seperated list of valid values.

False

list

boolean

(List)

A boolean value (true, false) determining whether or not to return the list which the card belongs to.

False

list_fields

string

(List Fields)

List the list fields to return. Specify 'all' or a comma seperated list of valid values.

False

stickers

boolean

(Stickers)

A boolean value (true, false) determining whether or not to return the stickers.

False

sticker_fields

string

(Sticker Fields)

List the sticker fields to return for each sticker. Specify 'all' or a comma seperated list of valid values.

False

fields

string

(Fields)

List the card fields to return.

False

 

Returns:

          Type:Card

          Description: A Trello Card Object

 

UpdateCard

Summary: Update a card

Description: Update an existing card with new parameters.

 

Syntax:

Trello.UpdateCard (string board_id, string card_id, UpdateCard updateCard)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board id)

The id of the board to fetch cards from.

True

ListBoardsSimple

card_id

string

(Card id)

The id of the card to update.

True

ListCardsSimple

updateCard

UpdateCard

 

Model for updating a card in Trello.

True

 

Returns:

          Type:Card

          Description: A Trello Card Object

 

DeleteCard

Summary: Delete a card

Description: Delete an existing card from the account.

 

Syntax:

Trello.DeleteCard (string board_id, string card_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The id of the board to fetch cards from.

True

ListBoardsSimple

card_id

string

(Card Id)

The id of the card to delete.

True

ListCardsSimple

 

Returns:

          Type:Object

 

CreateCard

Summary: Create a card

Description: Creates a new card with the parameters provided.

 

Syntax:

Trello.CreateCard (string board_id, CreateCard newCard)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The id of the board to create the card in.

True

ListBoardsSimple

newCard

CreateCard

 

Model for creating a new card in Trello.

True

 

Returns:

          Type:Object

 

ListBoards

Summary: List boards

Description: List the boards matching the specified query parameters.

 

Syntax:

Trello.ListBoards ([advanced][Optional]string filter, [advanced][Optional]string fields, [advanced][Optional]string actions, [advanced][Optional]boolean actions_entities, [advanced][Optional]integer actions_limit, [advanced][Optional]string actions_format, [advanced][Optional]string actions_since, [advanced][Optional]string action_fields, [advanced][Optional]string memberships, [advanced][Optional]boolean organization, [advanced][Optional]string organization_fields, [advanced][Optional]string lists)

 

Parameters:

Name

Type

Summary

Required

Related Action

filter

string

(Filter)

List filters to apply to board results. Specify 'all' or a comma seperated list of valid values.

False

fields

string

(Fields)

List the board fields to return. Specify 'all' or a comma seperated list of valid values.

False

actions

string

(Actions)

List the action fields to return. Specify 'all' or a comma seperated list of valid values.

False

actions_entities

boolean

(Action Entities)

A boolean value (true, false) determining whether or not to return action entities.

False

actions_limit

integer(int32)

(Action Limit)

The max number of actions to return.

False

actions_format

string

(Actions Format)Values: [count, list, minimal]

Specify the format of the actions to return. The valid options are 'count', 'list', 'minimal'.

False

actions_since

string(date-time)

(Actions Since)

Return actions after the specified date.

False

action_fields

string

(Action Fields)

List the fields of the action to return. Specify 'all' or a comma seperated list of valid values.

False

memberships

string

(Memberships)

Specify membership information to return.

False

organization

boolean

(Organization)

A boolean value (true, false) determining whether or not to return organization information.

False

organization_fields

string

(Organization Fields)

List the organization fields to return. Specify 'all' or a comma seperated list of valid values.

False

lists

string

(Lists)

Specify whether to return lists which belong to the board.

False

 

Returns:

          Type:array of (Board)

 

ListBoardsSimple

Summary: A simple version of the list boards

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

 

Syntax:

Trello.ListBoardsSimple ()

 

Returns:

          Type:array of (Board)

 

GetBoard

Summary: Get a board by Id

Description: Get a specific board by its unique identifier.

 

Syntax:

Trello.GetBoard (string board_id, [advanced][Optional]string actions, [advanced][Optional]boolean action_entities, [advanced][Optional]boolean actions_display, [advanced][Optional]string actions_format, [advanced][Optional]string actions_since, [advanced][Optional]integer actions_limit, [advanced][Optional]string action_fields, [advanced][Optional]boolean action_memeber, [advanced][Optional]string action_member_fields, [advanced][Optional]boolean action_memberCreator, [advanced][Optional]string action_memberCreator_fields, [advanced][Optional]string cards, [advanced][Optional]string card_fields, [advanced][Optional]boolean card_attachments, [advanced][Optional]string card_attachment_fields, [advanced][Optional]string card_checklists, [advanced][Optional]boolean card_stickers, [advanced][Optional]string boardStarts, [advanced][Optional]string labels, [advanced][Optional]string label_fields, [advanced][Optional]integer labels_limits, [advanced][Optional]string lists, [advanced][Optional]string list_fields, [advanced][Optional]string memberships, [advanced][Optional]boolean memberships_member, [advanced][Optional]string memberships_member_fields, [advanced][Optional]string members, [advanced][Optional]string member_fields, [advanced][Optional]string membersInvited, [advanced][Optional]string membersInvited_fields, [advanced][Optional]string checklists, [advanced][Optional]string checklist_fields, [advanced][Optional]boolean organization, [advanced][Optional]string organization_fields, [advanced][Optional]string organization_memberships, [advanced][Optional]boolean myPerfs, [advanced][Optional]string fields)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique Id of the board to get.

True

ListBoardsSimple

actions

string

(Actions)

List the actions to return. Specify 'all' or a comma seperated list of valid values.

False

action_entities

boolean

(Action Entities)

A boolean value (true, false) determining whether or not to return action entities.

False

actions_display

boolean

(Actions Display)

A boolean value (true, false) determining whether or not to return actions display.

False

actions_format

string

(Actions Format)Values: [count = null, list = null, minimal]

Specify the format of the actions to return. Valid options are 'count = null', 'list = null', 'minimal'.

False

actions_since

string(date-time)

(Actions Since)

Only return the actions after this date.

False

actions_limit

integer(int32)

(Actions Limit)

Max number of actions to return.

False

action_fields

string

(Action Field)

List the fields to return with each field. Specify 'all' or a comma seperated list of valid values.

False

action_memeber

boolean

(Action Member)

A boolean value (true, false) determining whether or not to return action members.

False

action_member_fields

string

(Action Member Fields)

List the member fields to return with each action member. Specify 'all' or a comma seperated list of valid values.

False

action_memberCreator

boolean

(Action Member Creator)

A boolean value (true, false) determining whether or not to return action member creator.

False

action_memberCreator_fields

string

(Action Member Creator Fields)

List the action member creator fields to return. Specify 'all' or a comma seperated list of valid values.

False

cards

string

(Cards)Values: [all = null, closed = null, none = null, open = null, visible]

Specify the cards to return. Valid options are 'all = null', 'closed = null', 'none = null', 'open = null', or 'visible'.

False

card_fields

string

(Card Fields)

List the fields to return for each card. Specify 'all' or a comma seperated list of valid values.

False

card_attachments

boolean

(Card Attachments)

A boolean value (true, false) determining whether or not to return attachments on cards.

False

card_attachment_fields

string

(Card Attachment Fields)

List the attachment fields to return for each attachment. Specify 'all' or a comma seperated list of valid values.

False

card_checklists

string

(Card Checklists)Values: [all = null, none]

Specify the checklists to return for each card.

False

card_stickers

boolean

(Card Stickers)

A boolean value (true, false) determining whether or not to return card stickers.

False

boardStarts

string

(Board Stars)Values: [mine = null, none]

Specify the board stars to return.

False

labels

string

(Labels)Values: [all = null, none]

Specify the labels to return.

False

label_fields

string

(Label Fields)

List the label fields to return for each label. Specify 'all' or a comma seperated list of valid values.

False

labels_limits

integer(int32)

(Label Limits)

Max number of labels to return.

False

lists

string

(Lists)Values: [all = null, closed = null, none = null, open]

Specify the lists to return.

False

list_fields

string

(List Fields)

List the list fields to return for each list. Specify 'all' or a comma seperated list of valid values.

False

memberships

string

(Memberships)

List the memberships to return. Specify 'all' or a comma seperated list of valid values.

False

memberships_member

boolean

(Memberships Member)

A boolean value (true, false) determining whether or not to return membership members.

False

memberships_member_fields

string

(Memberships Member Fields)

List the member fields to return for each membership member. Specify 'all' or a comma seperated list of valid values.

False

members

string

(Members)Values: [admins = null, all = null, none = null, normal = null, owners]

List the members to return. Specify 'all' or a comma seperated list of valid values.

False

member_fields

string

(Member Fields)

List the member fields to return for each member. Specify 'all' or a comma seperated list of valid values.

False

membersInvited

string

(Invited Members)Values: [admin = null, all = null, none = null, normal = null, owners]

Specify the invited members to return.

False

membersInvited_fields

string

(Invited Member Fields)

List the fields to return for each. Specify 'all' or a comma seperated list of valid values.

False

checklists

string

(Checklists)Values: [all = null, none]

Specify the checklists to return.

False

checklist_fields

string

(Checklist Fields)

List the checklist fields to return for each checklist. Specify 'all' or a comma seperated list of valid values.

False

organization

boolean

(Organization)

A boolean value (true, false) determining whether or not to return the organization information.

False

organization_fields

string

(Organization Fields)

List the organization fields to return for each organization. Specify 'all' or a comma seperated list of valid values.

False

organization_memberships

string

(Organization Memberships)

List the organization memberships to return. Specify 'all' or a comma seperated list of valid values.

False

myPerfs

boolean

(My perfs)

A boolean value (true, false) determining whether or not to return my perfs.

False

fields

string

(Fields)

List the fields to return. Specify 'all' or a comma seperated list of valid values.

False

 

Returns:

          Type:Board

          Description: A Trello Board Object

 

UpdateBoard

Summary: Update a board

Description: Update an existing board.

 

Syntax:

Trello.UpdateBoard (string board_id, [Optional]UpdateBoard board)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique identifier of the board to update.

True

ListBoardsSimple

board

UpdateBoard

 

A Trello Board Object used to create a board

False

 

Returns:

          Type:Board

          Description: A Trello Board Object

 

ListLists

Summary: List the card lists in a board

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

 

Syntax:

Trello.ListLists (string board_id, [advanced][Optional]string cards, [advanced][Optional]string card_fields, [advanced][Optional]string filter, [advanced][Optional]string fields)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board to fetch lists.

True

ListBoardsSimple

cards

string

(Cards)Values: [all, closed, open, none, visible]

Specify the cards to return.

False

card_fields

string

(Card Fields)

List the card fields to return from. Specify 'all' or a comma seperated list of valid values.

False

filter

string

(Filter)Values: [all, closed, none, open]

Specify the filter property for lists. Valid options are 'all, 'closed', 'none', or 'open'.

False

fields

string

(Fields)

List the fields to return. Specify 'all' or a comma seperated list of valid values.

False

 

Returns:

          Type:array of (List)

 

ListListsSimple

Summary: A simple version of list cards

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

 

Syntax:

Trello.ListListsSimple (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

Unique Id of the board to fetch lists

True

ListBoardsSimple

 

Returns:

          Type:array of (List)

 

GetList

Summary: Get list by Id

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

 

Syntax:

Trello.GetList (string board_id, string list_id, [advanced][Optional]string cards, [advanced][Optional]string card_fields, [advanced][Optional]boolean board, [advanced][Optional]string board_fields, [advanced][Optional]string fields)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique Id of the board to fetch the lists from.

True

ListBoardsSimple

list_id

string

(List Id)

The unique Id of the list to fetch.

True

ListListsSimple

cards

string

(Cards)Values: [all, closed, none, open]

Specify the cards to return.

False

card_fields

string

(Card Fields)

List the card fields to return for each card. Specify 'all' or a comma seperated list of valid values.

False

board

boolean

(Board)

A boolean value (true, false) determining whether or not to return board information.

False

board_fields

string

(Board Fields)

List the board fields to return. Specify 'all' or a comma seperated list of valid values.

False

fields

string

(List Fields)

List the list fields to return. Specify 'all' or a comma seperated list of valid values.

False

 

Returns:

          Type:List

          Description: A Trello List Object

 

UpdateList

Summary: Update a list

Description: Update an existing list.

 

Syntax:

Trello.UpdateList (string board_id, string list_id, [Optional]string name, [advanced][Optional]string closed, [advanced][Optional]string idBoard, [advanced][Optional]string pos, [advanced][Optional]string subscribed)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board the list is on.

True

ListBoardsSimple

list_id

string

(List Id)

The unique id of the list to update.

True

ListListsSimple

name

string

(List Name)

The new list name.

False

closed

string

(Closed)Values: [true, false]

A string (true, false) determining whether or not to close the list.

False

idBoard

string

(Board to move to)

The unique id of the board to move the list to.

False

ListBoardsSimple

pos

string

(List Position)Values: [top, bottom]

The list position (top, bottom, or number).

False

subscribed

string

(Subscribed)Values: [true, false]

A boolean value (true, false) determining whether or not to subscribe to the list.

False

 

Returns:

          Type:CreateList

          Description: A Trello List Object

 

ListTeams

Summary: List teams you are a member of

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

 

Syntax:

Trello.ListTeams ()

 

Returns:

          Type:array of (Team)

 

ListTeamMembers

Summary: List members of a team

Description: List the members in a specific team.

 

Syntax:

Trello.ListTeamMembers (string teamId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamId

string

(Team Id)

The unique Id of the team.

True

ListTeams

 

Returns:

          Type:array of (Member)

 

ListBoardMembers

Summary: List members of a board

Description: List the members of a specific board.

 

Syntax:

Trello.ListBoardMembers (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique Id of the board.

True

ListBoardsSimple

 

Returns:

          Type:array of (Member)

 

GetTeamForBoard

Summary: Get the team for a board

Description: Get the team details for a specific board.

 

Syntax:

Trello.GetTeamForBoard (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique Id of the board to fetch team.

True

ListBoardsSimple

 

Returns:

          Type:Team

          Description: A Trello Team

 

ListCardMembers

Summary: List members for a card

Description: List the members for a specific card.

 

Syntax:

Trello.ListCardMembers (string board_id, string card_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board to look for cards on.

True

ListBoardsSimple

card_id

string

(Card Id)

The unique id of the card.

True

ListCardsSimple

 

Returns:

          Type:array of (Member)

 

ListCardComments

Summary: List comments for a card

Description: List the comments for a specific card.

 

Syntax:

Trello.ListCardComments (string board_id, string card_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board to look for comments on.

True

ListBoardsSimple

card_id

string

(Card Id)

The unique id of the card.

True

ListCardsSimple

 

Returns:

          Type:array of (Comment)

 

AddCommentToCard

Summary: Add a comment to a card

Description: Add a comment to a specific card.

 

Syntax:

Trello.AddCommentToCard (string board_id, string card_id, CommentPost comment)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board to add a comment to.

True

ListBoardsSimple

card_id

string

(Card Id)

The unique id of the card.

True

ListCardsSimple

comment

CommentPost

 

The model for posting a comment

True

 

Returns:

          Type:Comment

          Description: The model for getting a comment

 

AddMemberToCard

Summary: Add member to a card

Description: Add a member to a specific card.

 

Syntax:

Trello.AddMemberToCard (string board_id, string cardId, string memberId)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board the card is on.

True

ListBoardsSimple

cardId

string

(Card Id)

The unique identifier of the card to add a member to.

True

ListCardsSimple

memberId

string

(Member Id or Username)

The member id or username to add to the card.

True

ListBoardMembers

 

Returns:

          Type:array of (Member)

 

CreateBoard

Summary: Create a board

Description: Create a new board with the specified fields.

 

Syntax:

Trello.CreateBoard (CreateBoard board)

 

Parameters:

Name

Type

Summary

Required

Related Action

board

CreateBoard

 

A Trello Board Object used to create a board

True

 

Returns:

          Type:Board

          Description: A Trello Board Object

 

CreateList

Summary: Create a list

Description: Create a new list.

 

Syntax:

Trello.CreateList (CreateList list)

 

Parameters:

Name

Type

Summary

Required

Related Action

list

CreateList

 

A Trello List Object

True

 

Returns:

          Type:CreateListResponse

          Description: A Trello List Object

 

CloseBoard

Summary: Close a board

Description: Set a specific board to closed.

 

Syntax:

Trello.CloseBoard (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board to close.

True

ListBoardsSimple

 

Returns:

          Type:Board

          Description: A Trello Board Object

 

Triggers:

Trigger OnNewCardInBoard

Summary: When a new card is added to a board

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

 

Syntax:

Trello.OnNewCardInBoard (string board_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board.

True

ListBoardsSimple

 

Returns:

          Type:array of (Card)

 

Trigger OnNewCardInList

Summary: When a new card is added to a list

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

 

Syntax:

Trello.OnNewCardInList (string board_id, string list_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

board_id

string

(Board Id)

The unique id of the board.

True

ListBoardsSimple

list_id

string

(List Id)

The unique id of the list in the specified board.

True

ListListsSimple

 

Returns:

          Type:array of (Card)

 


 

Badges

Summary:

Description: A Trello Badges Object

 

          Properties:

Name

Type

Summary

Votes

integer(int32)

Votes

The number of votes on the card badges.

ViewingMemberVoted

boolean

Viewing Member Voted

A boolean value (true, false) determining whether or not viewing members voted on the badge.

Subscribed

boolean

Subsribed To Badge

A boolean value (true, false) determining whether or not the account is subscribed to the card badges.

Fogbugz

string

Fogbugz

The fogbugz of the badges.

CheckItems

integer(int32)

Check Items

The number of check items in the badge.

CheckItemsChecked

integer(int32)

Checked Check Items

The number of checked check items in the badge.

Comments

integer(int32)

Comments

The comments on the badge.

Attachments

integer(int32)

Attachments

The attachments on the badge.

Description

boolean

Description

The description of the badge.

Due

string(date-time)

Due Date

The due date of the badge.


 

Board

Summary:

Description: A Trello Board Object

 

          Properties:

Name

Type

Summary

id

string

Board Id

The unique Id of the board.

closed

boolean

Is Closed

A boolean value (true, false) determining whether or not the board is closed.

dateLastActivity

string(date-time)

Last Activity Date

Date of the last activity on the board.

dateLastView

string(date-time)

Last Viewed Date

Date of the last time the board is viewed.

desc

string

Board Description

The description of the board.

idOrganization

string

Organization Id

The id of the organization.

invitations

array of (string)

Invitations

The list of invitations on the board.

invited

boolean

Invited

A boolean value (true, false) determining whether or not the account is invited to the board.

labelNames

Label

 

A Trello Label Object

memberships

array of (Membership)

Board Memberships

The set of board memberships.

name

string

Board Name

The name of the board.

pinned

boolean

Is Board Pinned

A boolean value (true, false) determining whether or not the board is pinned.

powerUps

array of (string)

Powerups

The set of power ups on the board.

perfs

Perfs

 

A Trello Perfs Object

shortLink

string

Board Short Link

The short link of the board.

shortUrl

string

Board Short Url

The short url to the board.

starred

string

Is Starred

A value determining whether or not the board is starred.

subscribed

string

Subscribed To Board

A value determining whether or not the account is subscribed to the board.

url

string

Board Url

The full url of the board.


 

Card

Summary:

Description: A Trello Card Object

 

          Properties:

Name

Type

Summary

id

string

Card Id

The unique id of the card.

checkItemStates

array of (string)

Check Item States

The check item states in the card.

closed

boolean

Card closed

A boolean value (true, false) determining whether or not the card is closed.

dateLastActivity

string(date-time)

Last Activity Date

The datetime of last activity on the card.

desc

string

Card Description

The description of the card.

idBoard

string

Board Id

The unique Id of the board which the card belongs to.

idList

string

List Id

The unique Id of the list which the card belongs to.

idMembersVoted

array of (string)

Voted Member Ids

The unique Ids of the voting members.

idShort

integer(int32)

Card Short Id

The short Id of the card.

idAttachmentCover

string

Attachment Cover Id

The unique Id of the attachment cover.

manualCoverAttachment

boolean

Is Manual Cover Attachment

A boolean value (true, false) determining whether or not the card has a manual cover attachment.

idLabels

array of (string)

Label Ids

A list of label Ids on the card.

name

string

Card Name

The name of the card.

pos

integer(int32)

Card Position

The position of the card.

shortLink

string

Card Short Link

A short link to the card.

badges

Badges

 

A Trello Badges Object

due

string(date-time)

Card Due Date

The due date of the card.

shortUrl

string

Card Short Url

The short url link to the card.

subscribed

boolean

Is Subscribed

A boolean value (true, false) determining whether or not the card is subscribed to.

url

string

Card Full Url

The full url to the card.


 

Comment

Summary:

Description: The model for getting a comment

 

          Properties:

Name

Type

Summary

memberCreator

Member

 

A Trello Member Object

text

string

Comment Text

The text of the comment.

date

string(date-time)

Datetime Created

The datetime the comment was left.


 

CommentPost

Summary:

Description: The model for posting a comment

 

          Properties:

Name

Type

Summary

text

string

Comment Text

The text of the comment.


 

CreateBoard

Summary:

Description: A Trello Board Object used to create a board

 

          Properties:

Name

Type

Summary

name

string

Board Name

The name of the board.

defaultLists

string

Create Default Lists

A string (true, false) determining whether or not to create default lists.  Values: [true, false]

desc

string

Board Description

The description of the board.

idOrganization

string

Team Id

The id of the team.

prefs_permissionLevel

string

Permission Level

The permission level of the board. Valid options are 'org', 'private', or 'public'.  Values: [org, private, public]

prefs_comments

string

Comment Preferences

The comment preferences of the board.  Values: [disabled, members, observers, org, public]

prefs_invitations

string

Invitation Preferences

The invitation preferences of the board.  Values: [admins, members]

prefs_cardCovers

string

Use Card Covers

A string (true, false) determining whether or not to use card covers.  Values: [true, false]

prefs_background

string

Background Color

The background color of the board.  Values: [blue, orange, green, red, purple, pink, lime, sky, grey]

prefs_voting

string

Voting Power-up Preferences

The voting power-up preferences of the board.  Values: [disabled, members, observers, org, public]

prefs_cardAging

string

Card Aging Power-up Preferences

The card aging power-up preferences of the board.  Values: [disabled, pirate, regular]

enable_calendar

string

Enable Calendar Power-up

A string (true, false) determining whether or not to enable calendar power-up.  Values: [true, false]


 

CreateCard

Summary:

Description: Model for creating a new card in Trello.

 

          Properties:

Name

Type

Summary

idList

string

Parent List Id

The id of the list that the card should be added to.

name

string

Card Name

The name of the new card.

desc

string

Card Description

The description of the new card.

pos

string

Card Position

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.  Values: [top, bottom]

idMembers

string

Member Id

A comma seperated list of member Ids to attach to the card.

idLabels

string

Label Id

A comma-separated list of labels Ids to attach to the card.

urlSource

string

Source Url

Source url of the card. Has to be a URL starting with http:// or https:// or null.

fileSource

string

Source File

Source file of the card.

idCardSource

string

Source Card Id

The Id of the card to copy into a new card.

keepFromSource

string

Properties From Source Card

Properties of the card to copy over from the source.

due

string

Due Date

The due date of the card.


 

CreateList

Summary:

Description: A Trello List Object

 

          Properties:

Name

Type

Summary

name

string

List Name

The name of the list.

idBoard

string

Board Id

The unique Id of the board to create the list in.

pos

string

List Position

The position of the list. Specify top, bottom, or a positive number.  Values: [top, bottom]

idListSource

string

List Source

The id of the list to copy into the new list.


 

CreateListResponse

Summary:

Description: A Trello List Object

 

          Properties:

Name

Type

Summary

id

string

List Id

The unique Id of the list.

name

string

List Name

The name of the list.

idBoard

string

Board Id

The unique Id of the board the list belongs to.

pos

string

List Position

The position of the list.  Values: [top, bottom]


 

Label

Summary:

Description: A Trello Label Object

 

          Properties:

Name

Type

Summary

green

string

Green Label

The value of the green label.

yellow

string

Yellow Label

The value of the yellow label.

orange

string

Orange Label

The value of the orange label.

red

string

Red Label

The value of the red label.

purple

string

Purple Label

The value of the purple label.

blue

string

Blue Label

The value of the blue label.

sky

string

Sky Blue Label

The value of the sky blue label.

lime

string

Lime Green Label

The value of the lime green label.

pink

string

Pink Label

The value of the pink label.

black

string

Black Label

The value of the black label.


 

List

Summary:

Description: A Trello List Object

 

          Properties:

Name

Type

Summary

id

string

List Id

The unique Id of the list.

name

string

List Name

The name of the list.

closed

boolean

Is Closed

A boolean value (true, false) determining whether or not the list is closed.

idBoard

string

Board Id

The unique Id of the board which the list belongs to.

pos

number(double)

List Position

The position of the list.

subscribed

boolean

Is List Subscribed To

A boolean value (true, false) determining whether or not to the account is subscribed to the list.

cards

array of (Card)

Cards In List

The cards inside the list.

board

Board

 

A Trello Board Object


 

Member

Summary:

Description: A Trello Member Object

 

          Properties:

Name

Type

Summary

id

string

Member Id

The unique Id of the member.

fullName

string

Full Name

The full name of the member.

username

string

Username

The username of the member.

initials

string

Initials

The initials of the member.


 

Membership

Summary:

Description: A Trello Membership Object

 

          Properties:

Name

Type

Summary

id

string

Membership Id

The unique Id of the membership.

idMember

string

Member Id

The unique Id of the member.

memberType

string

Member type

The type of member.

unconfirmed

boolean

Unconfirmed Membership

A boolean value (true, false) determining whether or not the membership is unconfirmed.


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Perfs

Summary:

Description: A Trello Perfs Object

 

          Properties:

Name

Type

Summary

permissionLevel

string

Permission Level

The permission level of the object.

voting

string

Voting Permission

Who can vote on the object.

comments

string

Commenting Permission

Who can comment on the object.

invitations

string

Invitation Permission

Who can invite people to the object.

selfJoin

boolean

Self Join Permission

A boolean value (true, false) determining whether or not the object can self join.

cardCovers

boolean

Can Access Card Covers

A boolean value (true, false) determining whether or not the object has access to card covers.

calendarFeedEnabled

boolean

Is Calendar Feed Enabled

A boolean value (true, false) determining whether or not the calendar feed enabled.

background

string

Object Background

The background of the object.

backgroundColor

string

Object Background Color

The background color of the object, in hex notation.

backgroundImage

string

Object Background Image

The background image of the object.

backgroundImageScaled

string

Scaled Backgorund Image

The scaled version of the background image.

backgroundTile

boolean

Object Background Tile

The background tile of the object.

backgroundBrightness

string

Background Brightness

The brightness of the object background.

canBePublic

boolean

Can Object be Public

A boolean value (true, false) determining whether or not the object can be public.

canBeOrg

boolean

Can be Part of Organization

A boolean value (true, false) determining whether or not the object can be part of the organization

canBePrivate

boolean

Can Object be Private

A boolean value (true, false) determining whether or not the object can be private.

canInvite

boolean

Can Invite

A boolean value (true, false) determining whether or not the object can have invititations.


 

Team

Summary:

Description: A Trello Team

 

          Properties:

Name

Type

Summary

id

string

Team Id

The unique ID of the team.

desc

string

Team Description

The description of the team.

displayName

string

Team Display Name

The display name of the team.

idBoards

array of (string)

Board Ids

The boards assigned to this team.

billableMemberCount

integer(int32)

Member Count

The number of members in this team.

memberships

array of (Membership)

Memberships

The memberships for this team.

WebSite

string

Website

The team website.

prefs

TeamPreferences

 

A Trello Team Preference Object


 

TeamPreferences

Summary:

Description: A Trello Team Preference Object

 

          Properties:

Name

Type

Summary

permissionLevel

string

Permission Level

The permission level of the team.


 

UpdateBoard

Summary:

Description: A Trello Board Object used to create a board

 

          Properties:

Name

Type

Summary

name

string

Board Name

The name of the board.

defaultLists

string

Create Default Lists

A string (true, false) determining whether or not to create default lists.  Values: [true, false]

desc

string

Board Description

The description of the board.

idOrganization

string

Team Id

The id of the team.

prefs_permissionLevel

string

Permission Level

The permission level of the board.  Values: [org, private, public]

prefs_comments

string

Comment Preferences

The comment preferences on the board. Valid options are 'disabled', 'members', 'observers', 'org' or 'public'.  Values: [disabled, members, observers, org, public]

prefs_invitations

string

Invitation Preferences

The invitation preferences of the board. Valid options are 'admins' or 'members'.  Values: [admins, members]

prefs_cardCovers

string

Use Card Covers

A string (true, false) determining whether or not to use card covers.  Values: [true, false]

prefs_background

string

Background Color

The background color of the board.  Values: [blue, orange, green, red, purple, pink, lime, sky, grey]

prefs_voting

string

Voting Power-up Preferences

The voting power-up preferences of the board.  Values: [disabled, members, observers, org, public]

prefs_cardAging

string

Card Aging Power-up Preferences

The card aging power-up preferences of the board.  Values: [disabled, pirate, regular]

enable_calendar

string

Enable Calendar Power-up

A string (true, false) determining whether or not to enable calendar power-up  Values: [true, false]


 

UpdateCard

Summary:

Description: Model for updating a card in Trello.

 

          Properties:

Name

Type

Summary

name

string

Name

The updated name of the new card.

desc

string

Description

The updated description of the new card.

closed

boolean

Is Closed

A boolean value (true, false) determining whether or not the card is closed.

idMembers

string

Member Ids

The id of the members to add to the card.

idAttachmentCover

string

Cover attachment Ids

The id of the attachemnt to attach to the card.

idBoard

string

Board Id

The id of the board to attach the card to.

idList

string

List Id

The id of the list to attach the card to.

pos

string

Position

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

string

Due Date

The due date of the card.

subscribed

boolean

Subscribed To Card

A boolean value (true, false) determining whether or not to subscribe to the card.