Boards

API calls for Boards: Columns and Cards


Create a new Column

Allows you to create a new Column in your Boards view

Perform a POST to /projects/{project_id}/boards/columns.json

Request

{
	"column": {
		"name": "new card name",
		"color": "#1ABC9C"
	}
}

Column Colours

The following colours can be used when creating Columns

#27AE60, #99DF72, #1ABC9C, #6866D0, #8E44AD, #0AD2F5, #3498DB, #3D82DE, #C0392B, #E74C3C, #A94136, #660A00, #F39C12, #F1C40F, #34495E, #7F8C8D, #D35400, #B49255, #D870AD, #BDC3C7, #9B59B6

Response

The 'id' is the id assigned to your new Column

{
	"id": "10001",
	"STATUS": "OK"
}


List Columns

Allows you to list all existing Columns in your Boards view

Perform a GET to /projects/{project_id}/boards/columns.json

Parameters

Attribute Req/Opt Default Description
page Optional 1 The page number to get
pageSize Optional   The number of records to return per page
showDeleted Optional 0 Show deleted Columns in the API response or not
deletedAfterDate Optional   Show Columns deleted after a given date
updatedAfterDate Optional   Show Columns updated after a given date

Response

{
	"columns": [
		{
			"name": "My new Column",
			"displayOrder": "4000",
			"sortOrder": "ASC",
			"deletedDate": "",
			"dateUpdated": "yyyy-mm-ddThh:mm:ssZ",
			"settings": {
				"avatar": true,
				"time": true,
				"name": true,
				"files": true,
				"comments": true,
				"priority": true,
				"progress": true,
				"tasklist": true,
				"private": true,
				"reminders": true,
				"assignee": true,
				"dependencies": true,
				"tags": true,
				"estimatedtime": true,
				"startdate": true,
				"tickets": true,
				"followers": true,
				"recurring": true,
				"subtasklabel": true,
				"enddate": true
			},
			"defaultTasklist": {
				"newTaskDefaults": {},
				"name": "",
				"id": "0"
			},
			"projectId": "12345",
			"hasTriggers": false,
			"sort": "manual",
			"canEdit": true,
			"id": "1001",
			"dateCreated": "yyyy-mm-ddThh:mm:ssZ",
			"color": "#1ABC9C",
			"deleted": false,
			"canAddCards": true
		}
	],
	"people": {
		"123": {
			"company": {
				"name": "My Company",
				"id": "1234"
			},
			"avatarUrl": "https://path/to/image.png",
			"firstName": "Joe",
			"id": "123",
			"lastName": "Bloggs"
		}
	},
	"STATUS": "OK"
}


Delete a Column

Remove a Column from your boards view

Perform a DELETE to /boards/columns/{column_id}.json

Response

{"STATUS":"OK"}


Add a Task from the Backlog to a Column

Add a task from your list of Tasks in to a Column

Perform a POST to /boards/columns/{column_id}/cards.json

Request

{
	"card": {
		"taskId": 12345
	},
	"positionAfterId": -1
}

Response

{
	"cardId": "1002",
	"taskId": "12345",
	"STATUS": "OK"
}


List Cards in a Column

List the existing Cards inside a Column

Perform a GET to /boards/columns/{column_id}/cards.json

Parameters

Attribute Req/Opt Default Description
page Optional 1 The page number to get
pageSize Optional   The number of records to return per page
showDeleted Optional   Show deleted Cards in the API response or not
searchTerm Optional   An optional term to filter down to Cards containing this text in the Cards name
responsible-party-ids Optional    
deletedAfterDate Optional   Show Cards deleted after a given date
updatedAfterDate Optional   Show Cards updated after a given date

Response

{
	"people": {
		"12345": {
			"company": {
				"name": "My Company",
				"id": "1234"
			},
			"avatarUrl": "https://path/to/person.jpg",
			"firstName": "Joe",
			"id": "123",
			"lastName": "Bloggs"
		}
	},
	"STATUS": "OK",
	"column": {
		"name": "Inbox Column",
		"id": "1003",
		"color": "#3D82DE"
	},
	"cards": [
		{
			"dueDate": "",
			"canComplete": true,
			"numComments": "0",
			"taskListId": "123456789",
			"displayOrder": "1",
			"hasTickets": false,
			"archived": false,
			"deletedDate": "",
			"dateUpdated": "yyyy-mm-ddThh:mm:ssZ",
			"dateCompleted": "",
			"private": "0",
			"projectId": "1",
			"status": "ACTIVE",
			"numPredecessors": "0",
			"numDependencies": "0",
			"numAttachments": "0",
			"canEdit": true,
			"tags": [],
			"startDate": "",
			"id": "1002",
			"hasLoggedTime": false,
			"dateCreated": "yyyy-mm-ddThh:mm:ssZ",
			"completed": false,
			"estimatedMinutes": "0",
			"deleted": false,
			"taskListName": "A task list",
			"taskStatus": "new",
			"columnId": "101",
			"name": "My task name",
			"description": "",
			"priority": "NONE",
			"progress": "0",
			"parentTaskId": "",
			"numActiveSubTasks": "0",
			"assignedPeople": [
				"123"
			],
			"taskId": "123456789",
			"isRecurring": false,
			"hasUnreadComments": false,
			"archivedDate": ""
		}
	]
}


Move a Card

Move a Card from one Column to another

Perform a PUT to /boards/columns/cards/{card_id}/move.json

Request

{
	"cardId": 101,
	"positionAfterId": 0,
	"columnId": 1003
}

Response

{"STATUS":"OK"}


Edit a Card

Edit the details of a Card

Perform a PUT to /boards/columns/cards/{card_id}.json

Request

{
	"card": {
		"content": "my updated card",
		"taskListId": "123456789",
		"start-date": "",
		"due-date": "",
		"responsible-party-id": "0",
		"estimated-minutes": 0,
		"priority": "none",
		"progress": "0",
		"tags": ""
	}
}

Response

{"STATUS":"OK"}


Remove a Card

Remove a Card from a Column (that task isn't deleted from the Tasklist)

Perform a DELETE to /boards/columns/cards/{card_id}.json

Response

{"STATUS":"OK"}