Skip to content

card_table_columns.md

Latest commit

 

History

History
285 lines (231 loc) · 9.73 KB

card_table_columns.md

File metadata and controls

285 lines (231 loc) · 9.73 KB

Card table columns

Endpoints:

Get a column

  • GET /card_tables/columns/2.json will return the column with an ID of 2.
Example JSON Response
{
  "id": 1069479400,
  "status": "active",
  "visible_to_clients": false,
  "created_at": "2026-01-31T08:32:04.760Z",
  "updated_at": "2026-01-31T08:33:00.710Z",
  "title": "Triage",
  "inherits_status": true,
  "type": "Kanban::Triage",
  "url": "https://3.basecampapi.com/195539477/buckets/2085958504/card_tables/columns/1069479400.json",
  "app_url": "https://3.basecamp.com/195539477/buckets/2085958504/card_tables/columns/1069479400",
  "bookmark_url": "https://3.basecampapi.com/195539477/my/bookmarks/BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiLmdpZDovL2JjMy9SZWNvcmRpbmcvMTA2OTQ3OTQwMD9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg1yZWFkYWJsZQY7AFQ=--76b2dfcd8a8eea46097d4f1ce80acf09d339e6d2.json",
  "subscription_url": "https://3.basecampapi.com/195539477/buckets/2085958504/recordings/1069479400/subscription.json",
  "parent": {
    "id": 1069479399,
    "title": "Card Table",
    "type": "Kanban::Board",
    "url": "https://3.basecampapi.com/195539477/buckets/2085958504/card_tables/1069479399.json",
    "app_url": "https://3.basecamp.com/195539477/buckets/2085958504/card_tables/1069479399"
  },
  "bucket": {
    "id": 2085958504,
    "name": "The Leto Laptop",
    "type": "Project"
  },
  "creator": {
    "id": 1049715913,
    "attachable_sgid": "BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiK2dpZDovL2JjMy9QZXJzb24vMTA0OTcxNTkxMz9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg9hdHRhY2hhYmxlBjsAVA==--e627c45e6b34e08862da23906862412620e4d5d9",
    "name": "Victor Cooper",
    "email_address": "victor@honchodesign.com",
    "personable_type": "User",
    "title": "Chief Strategist",
    "bio": "Don't let your dreams be dreams",
    "location": "Chicago, IL",
    "created_at": "2026-01-31T08:29:28.365Z",
    "updated_at": "2026-01-31T08:29:32.599Z",
    "admin": true,
    "owner": true,
    "client": false,
    "employee": true,
    "time_zone": "America/Chicago",
    "avatar_url": "https://3.basecampapi.com/195539477/people/BAhpBMlkkT4=--5fe7b70fbee7a7f0e2e1e19df7579e5d880c753d/avatar?v=1",
    "company": {
      "id": 1033447817,
      "name": "Honcho Design"
    },
    "can_ping": true,
    "can_manage_projects": true,
    "can_manage_people": true,
    "can_access_timesheet": true,
    "can_access_hill_charts": true
  },
  "description": null,
  "subscribers": [
    {
      "id": 1049715913,
      "attachable_sgid": "BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiK2dpZDovL2JjMy9QZXJzb24vMTA0OTcxNTkxMz9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg9hdHRhY2hhYmxlBjsAVA==--e627c45e6b34e08862da23906862412620e4d5d9",
      "name": "Victor Cooper",
      "email_address": "victor@honchodesign.com",
      "personable_type": "User",
      "title": "Chief Strategist",
      "bio": "Don't let your dreams be dreams",
      "location": "Chicago, IL",
      "created_at": "2026-01-31T08:29:28.365Z",
      "updated_at": "2026-01-31T08:29:32.599Z",
      "admin": true,
      "owner": true,
      "client": false,
      "employee": true,
      "time_zone": "America/Chicago",
      "avatar_url": "https://3.basecampapi.com/195539477/people/BAhpBMlkkT4=--5fe7b70fbee7a7f0e2e1e19df7579e5d880c753d/avatar?v=1",
      "company": {
        "id": 1033447817,
        "name": "Honcho Design"
      },
      "can_ping": true,
      "can_manage_projects": true,
      "can_manage_people": true,
      "can_access_timesheet": true,
      "can_access_hill_charts": true
    }
  ],
  "color": null,
  "cards_count": 1,
  "comment_count": 0,
  "cards_url": "https://3.basecampapi.com/195539477/buckets/2085958504/card_tables/lists/1069479400/cards.json"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/card_tables/columns/2.json

Create a column

  • POST /card_tables/2/columns.json creates a column within the card table with ID 2.

Required parameters: title of the column.

Optional parameters:

  • description - containing information about the column.

This endpoint will return 201 Created with the current JSON representation of the column if the creation was a success. See the Get a column endpoint for more info on the payload.

Example JSON Request
{
  "title": "In progress",
  "description": "Stuff we are working on actively"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"title":"In progress"}' \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/2/columns.json

Update a column

  • PUT /card_tables/columns/2.json allows changing of the column with an ID of 2.

This endpoint will return 200 OK with the current JSON representation of the column if the update was a success. See the Get a column endpoint for more info on the payload.

Example JSON Request
{
  "title": "On it",
  "description": "Stuff we are doing right now"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"title":"On it", "description":"Stuff we are doing right now"}' -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/columns/2.json

Move a column

  • POST /card_tables/2/moves.json allows moving of a column in the card table with id 2.

Required parameters:

  • source_id - the id of the column to move
  • target_id - the id of the card table

Optional parameters:

  • position - index among the columns (ignoring Triage, Not Now or Done). Default: 1

This endpoint will return 204 No Content if the update was a success.

Example JSON Request
{
  "source_id": 3,
  "target_id": 4,
  "position": 2
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"source_id": 3, "target_id":4, "position": 2}' \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/2/moves.json

Watch a column

  • POST /card_tables/lists/2/subscription.json starts watching the column with id 2.
  • DELETE /card_tables/lists/2/subscription.json stops watching the column with id 2.

This endpoint will return 204 No Content if the update was a success.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -X POST \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/lists/2/subscription.json
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -X DELETE \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/lists/2/subscription.json

Change on hold on a column

  • POST /card_tables/columns/2/on_hold.json creates an on_hold section in the column with ID 2.
  • DELETE /card_tables/columns/2/on_hold.json removes an on_hold section in the column with ID 2.

This endpoint will return 200 OK with the current JSON representation of the column if the operation was a success. See the Get a column endpoint for more info on the payload.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -X POST \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/columns/2/on_hold.json
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -X DELETE \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/columns/2/on_hold.json

Change color of a column

  • PUT /card_tables/columns/2/color.json allows changing the color of the column with an ID of 2.

This endpoint will return 200 OK with the current JSON representation of the column if the update was a success. See the Get a column endpoint for more info on the payload.

Required parameters:

  • color - the color. Available values: [ white red orange yellow green blue aqua purple gray pink brown ]
Example JSON Request
{
  "color": "orange"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"color":"orange"}' -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/card_tables/columns/2/color.json

Legacy project-scoped routes

The following project-scoped routes are still supported and will remain available, but flat routes above are the canonical form for new integrations.