Introduction
trello4j is a java wrapper around Trello API.
You need to get a API key and optionally generate a token here to be able to use Trello's API.
Please report any issues and/or participate in the development here :)
Getting started
Get source and build it:
git clone git@github.com:joelso/trello4j.git
cd trello4j
mvn install
Now you got two options:
- Use trello4j from your local maven repo, add dependency groupId: org.trello4j / artifactId: trello4j
- Use jar that was built in directory target/
Usage
// myToken is optional, set to null if you are accessing public data
Trello trello = new TrelloImpl("myApiKey", "myToken");
// example: get organization by its name
Organization org = trello.getOrganization("fogcreek");
Roadmap
- 1.0 - core read-only API methods
- 1.1 - fully support read-only methods (i.e. all GET methods)
- 2.0 - support create, update and delete
Method | Version |
---|---|
Actions | |
GET /1/actions/[action_id] | 1.0 - IMPLEMENTED |
GET /1/actions/[action_id]/[field] | 1.1 |
GET /1/actions/[action_id]/board | 1.1 |
GET /1/actions/[action_id]/board/[field] | 1.1 |
GET /1/actions/[action_id]/card | 1.1 |
GET /1/actions/[action_id]/card/[field] | 1.1 |
GET /1/actions/[action_id]/list | 1.1 |
GET /1/actions/[action_id]/list/[field] | 1.1 |
GET /1/actions/[action_id]/member | 1.1 |
GET /1/actions/[action_id]/member/[field] | 1.1 |
GET /1/actions/[action_id]/memberCreator | 1.1 |
GET /1/actions/[action_id]/memberCreator/[field] | 1.1 |
GET /1/actions/[action_id]/organization | 1.1 |
GET /1/actions/[action_id]/organization/[field] | 1.1 |
Boards | |
GET /1/boards/[board_id] | 1.0 - IMPLEMENTED |
GET /1/boards/[board_id]/[field] | 1.1 |
GET /1/boards/[board_id]/actions | 1.0 - IMPLEMENTED |
GET /1/boards/[board_id]/cards | 1.1 |
GET /1/boards/[board_id]/cards/[filter] | 1.1 |
GET /1/boards/[board_id]/cards/[idCard] | 1.1 |
GET /1/boards/[board_id]/checklists | 1.1 |
GET /1/boards/[board_id]/lists | 1.1 |
GET /1/boards/[board_id]/lists/[filter] | 1.1 |
GET /1/boards/[board_id]/members | 1.1 |
GET /1/boards/[board_id]/members/[filter] | 1.1 |
GET /1/boards/[board_id]/membersInvited | 1.1 |
GET /1/boards/[board_id]/membersInvited/[field] | 1.1 |
GET /1/boards/[board_id]/myPrefs | 1.1 |
GET /1/boards/[board_id]/organization | 1.1 |
GET /1/boards/[board_id]/organization/[field] | 1.1 |
PUT /1/boards/[board_id] | 2.0 |
PUT /1/boards/[board_id]/closed | 2.0 |
PUT /1/boards/[board_id]/desc | 2.0 |
PUT /1/boards/[board_id]/name | 2.0 |
POST /1/boards | 2.0 |
POST /1/boards/[board_id]/checklists | 2.0 |
POST /1/boards/[board_id]/lists | 2.0 |
POST /1/boards/[board_id]/myPrefs | 2.0 |
Cards | |
GET /1/cards/[card_id] | 1.0 - IMPLEMENTED |
GET /1/cards/[card_id]/[field] | 1.1 |
GET /1/cards/[card_id]/actions | 1.1 |
GET /1/cards/[card_id]/attachments | 1.1 |
GET /1/cards/[card_id]/board | 1.1 |
GET /1/cards/[card_id]/board/[field] | 1.1 |
GET /1/cards/[card_id]/checkItemStates | 1.1 |
GET /1/cards/[card_id]/checklists | 1.1 |
GET /1/cards/[card_id]/list | 1.1 |
GET /1/cards/[card_id]/list/[field] | 1.1 |
GET /1/cards/[card_id]/members | 1.1 |
PUT /1/cards/[card_id] | 2.0 |
PUT /1/cards/[card_id]/closed | 2.0 |
PUT /1/cards/[card_id]/desc | 2.0 |
PUT /1/cards/[card_id]/due | 2.0 |
PUT /1/cards/[card_id]/idList | 2.0 |
PUT /1/cards/[card_id]/name | 2.0 |
POST /1/cards | 2.0 |
POST /1/cards/[card_id]/actions/comments | 2.0 |
POST /1/cards/[card_id]/attachments | 2.0 |
POST /1/cards/[card_id]/checklists | 2.0 |
POST /1/cards/[card_id]/labels | 2.0 |
POST /1/cards/[card_id]/members | 2.0 |
POST /1/cards/[card_id]/membersVoted | 2.0 |
DELETE /1/cards/[card_id] | 2.0 |
DELETE /1/cards/[card_id]/checklists/[idChecklist] | 2.0 |
DELETE /1/cards/[card_id]/labels/[color] | 2.0 |
DELETE /1/cards/[card_id]/members/[idMember] | 2.0 |
DELETE /1/cards/[card_id]/membersVoted/[idMember] | 2.0 |
Checklists | |
GET /1/checklists/[checklist_id] | 1.0 - IMPLEMENTED |
GET /1/checklists/[checklist_id]/[field] | 1.1 |
GET /1/checklists/[checklist_id]/board | 1.1 |
GET /1/checklists/[checklist_id]/board/[field] | 1.1 |
GET /1/checklists/[checklist_id]/cards | 1.1 |
GET /1/checklists/[checklist_id]/cards/[filter] | 1.1 |
GET /1/checklists/[checklist_id]/checkItems | 1.1 |
PUT /1/checklists/[checklist_id] | 2.0 |
PUT /1/checklists/[checklist_id]/name | 2.0 |
POST /1/checklists | 2.0 |
POST /1/checklists/[checklist_id]/checkItems | 2.0 |
DELETE /1/checklists/[checklist_id]/checkItems/[idCheckItem] | 2.0 |
Lists | |
GET /1/lists/[list_id] | 1.0 - IMPLEMENTED |
GET /1/lists/[list_id]/[field] | 1.1 |
GET /1/lists/[list_id]/actions | 1.1 |
GET /1/lists/[list_id]/board | 1.1 |
GET /1/lists/[list_id]/board/[field] | 1.1 |
GET /1/lists/[list_id]/cards | 1.1 |
GET /1/lists/[list_id]/cards/[filter] | 1.1 |
PUT /1/lists/[list_id] | 2.0 |
PUT /1/lists/[list_id]/closed | 2.0 |
PUT /1/lists/[list_id]/name | 2.0 |
POST /1/lists | 2.0 |
POST /1/lists/[list_id]/cards | 2.0 |
Members | |
GET /1/members/[member_id or username] | 1.0 - IMPLEMENTED |
GET /1/members/[member_id or username]/[field] | 1.1 |
GET /1/members/[member_id or username]/actions | 1.1 |
GET /1/members/[member_id or username]/boards | 1.0 - IMPLEMENTED |
GET /1/members/[member_id or username]/boards/[filter] | 1.1 |
GET /1/members/[member_id or username]/boardsInvited | 1.1 |
GET /1/members/[member_id or username]/boardsInvited/[field] | 1.1 |
GET /1/members/[member_id or username]/cards | 1.1 |
GET /1/members/[member_id or username]/cards/[filter] | 1.1 |
GET /1/members/[member_id or username]/notifications | 1.1 |
GET /1/members/[member_id or username]/notifications/[filter] | 1.1 |
GET /1/members/[member_id or username]/organizations | 1.1 |
GET /1/members/[member_id or username]/organizations/[filter] | 1.1 |
GET /1/members/[member_id or username]/organizationsInvited | 1.1 |
GET /1/members/[member_id or username]/organizationsInvited/[field] | 1.1 |
PUT /1/members/[member_id or username] | 2.0 |
PUT /1/members/[member_id or username]/bio | 2.0 |
PUT /1/members/[member_id or username]/fullName | 2.0 |
PUT /1/members/[member_id or username]/initials | 2.0 |
Notifications | |
GET /1/notifications/[notification_id] | 1.0 - IMPLEMENTED |
GET /1/notifications/[notification_id]/[field] | 1.1 |
GET /1/notifications/[notification_id]/board | 1.1 |
GET /1/notifications/[notification_id]/board/[field] | 1.1 |
GET /1/notifications/[notification_id]/card | 1.1 |
GET /1/notifications/[notification_id]/card/[field] | 1.1 |
GET /1/notifications/[notification_id]/list | 1.1 |
GET /1/notifications/[notification_id]/list/[field] | 1.1 |
GET /1/notifications/[notification_id]/member | 1.1 |
GET /1/notifications/[notification_id]/member/[field] | 1.1 |
GET /1/notifications/[notification_id]/memberCreator | 1.1 |
GET /1/notifications/[notification_id]/memberCreator/[field] | 1.1 |
GET /1/notifications/[notification_id]/organization | 1.1 |
GET /1/notifications/[notification_id]/organization/[field] | 1.1 |
Organizations | |
GET /1/organizations/[org_id or name] | 1.0 - IMPLEMENTED |
GET /1/organizations/[org_id or name]/[field] | 1.1 |
GET /1/organizations/[org_id or name]/actions | 1.0 - IMPLEMENTED |
GET /1/organizations/[org_id or name]/boards | 1.0 - IMPLEMENTED |
GET /1/organizations/[org_id or name]/boards/[filter] | 1.1 |
GET /1/organizations/[org_id or name]/members | 1.1 |
GET /1/organizations/[org_id or name]/members/[filter] | 1.1 |
PUT /1/organizations/[org_id or name] | 2.0 |
PUT /1/organizations/[org_id or name]/desc | 2.0 |
PUT /1/organizations/[org_id or name]/displayName | 2.0 |
PUT /1/organizations/[org_id or name]/name | 2.0 |
PUT /1/organizations/[org_id or name]/website | 2.0 |
POST /1/organizations | 2.0 |
DELETE /1/organizations/[org_id or name] | 2.0 |
Tokens | |
GET /1/tokens/[token] | 1.1 |
GET /1/tokens/[token]/[field] | 1.1 |
GET /1/tokens/[token]/member | 1.1 |
GET /1/tokens/[token]/member/[field] | 1.1 |
Types | |
GET /1/types/[id] | 1.0 - IMPLEMENTED |