List Columns
Important notice: This endpoint will be deprecated soon and replaced with a new Workflow endpoint, date to be confirmed.
Allows you to list all existing Columns in your Boards view.
Example: https://yoursite.teamwork.com/projects/{id}/boards/columns.json?showDeleted=true&updatedAfterDate=20171119120101
Path Params
- Name
id
- Type
- integer
- required
- Description
Query Params
- Name
page
- Type
- integer
- Description
Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.
See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.
- Name
pageSize
- Type
- integer
- Description
The amount of columns returned can be limited using this parameter. Normally used in conjunction with the page parameter.
Minimum: 1
- Name
showDeleted
- Type
- boolean
- Description
Show deleted Columns in the API response or not
- Default
false
- Name
sortBy
- Type
- string
- Description
Sort by relevance eg. Date
- Name
sortOrder
- Type
- string
- Description
asc or desc - The order to sort the returned data
- Default
asc
- Allowed values
asc
desc
- Name
searchTerm
- Type
- string
- Description
Show specific column by name
- Name
getEmoji
- Type
- boolean
- Description
Show emojis in API response or not
- Default
false
- Name
includeDefaults
- Type
- boolean
- Description
Show/hide default tasklists
- Default
false
- Name
get
- Type
- string
- Description
Show people and/or default columns
- Name
updatedAfterDate
- Type
- string
- Description
Show Columns updated after a given date
- Name
getStats
- Type
- boolean
- Description
Show/hide information about cards within the column
- Default
false
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 Response
200 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,
"subtasktext": 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,
"parenttask": true,
"enddate": true
},
"defaultTasklist": {
"newTaskDefaults": {},
"name": "",
"id": "0"
},
"projectId": "12345",
"stats": {
"estimatedTime": "",
"total": "0",
"completed": "0",
"active": "0"
},
"hasTriggers": false,
"sort": "manual",
"canEdit": true,
"triggers": [],
"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"
}