Skip to content

calendars.md

Latest commit

 

History

History
82 lines (63 loc) · 2.22 KB

calendars.md

File metadata and controls

82 lines (63 loc) · 2.22 KB
Raw

Calendars

Available since Basecamp 5: per-account calendars are accessible via /calendars/:id.json, where :id is the calendar bucket's id (a Calendar is a bucketable of its own — distinct from a project). The calendar exposes display metadata (name, color) and a link to its underlying schedule resource.

Endpoints:

Get a calendar

  • GET /calendars/2.json returns the calendar with the bucket id 2.
Example JSON Response
{
  "id": 2085958497,
  "type": "Calendar",
  "name": "Honcho Design Calendar",
  "color": "blue",
  "created_at": "2026-05-28T17:22:22.133Z",
  "updated_at": "2026-07-20T04:05:52.374Z",
  "url": "https://3.basecampapi.com/195539477/calendars/2085958497.json",
  "app_url": "https://3.basecamp.com/195539477/calendars/2085958497",
  "schedule_url": "https://3.basecampapi.com/195539477/schedules/1069478892.json"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/calendars/2.json

Update a calendar

  • PUT /calendars/2.json updates the calendar with the bucket id 2.
Permitted parameters
Param Type Description
color String One of white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown.

Submitting an unknown color returns 422 Unprocessable Entity with a JSON errors payload.

Example JSON Request
{
  "calendar": {
    "color": "blue"
  }
}

Returns 200 OK with the updated calendar's JSON shape.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"calendar":{"color":"blue"}}' -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/calendars/2.json