Skip to content

schedules.md

Latest commit

 

History

History
118 lines (96 loc) · 3.78 KB

schedules.md

File metadata and controls

118 lines (96 loc) · 3.78 KB

Schedules

All schedule entries under a project are children of a schedule resource.

Endpoints:

Get schedule

  • GET /schedules/2.json will return the schedule with an ID of 2.

To get the schedule ID for a project, see the Get a project endpoint's dock payload. To retrieve its schedule entries, see the Get schedule entries endpoint.

Example JSON Response
{
  "id": 1069479396,
  "status": "active",
  "visible_to_clients": false,
  "created_at": "2026-02-12T06:09:34.690Z",
  "updated_at": "2026-02-12T06:10:28.425Z",
  "title": "Schedule",
  "inherits_status": true,
  "type": "Schedule",
  "url": "https://3.basecampapi.com/195539477/buckets/2085958504/schedules/1069479396.json",
  "app_url": "https://3.basecamp.com/195539477/buckets/2085958504/schedules/1069479396",
  "bookmark_url": "https://3.basecampapi.com/195539477/my/bookmarks/BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiLmdpZDovL2JjMy9SZWNvcmRpbmcvMTA2OTQ3OTM5Nj9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg1yZWFkYWJsZQY7AFQ=--a2a4e60ee2fe1403e8c2a043368cfaf36434bfd0.json",
  "position": 5,
  "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-02-12T06:08:49.342Z",
    "updated_at": "2026-02-12T06:08:50.871Z",
    "admin": true,
    "owner": true,
    "client": false,
    "employee": true,
    "time_zone": "America/Chicago",
    "avatar_url": "https://3.basecampapi.com/195539477/people/BAhpBMlkkT4=--5fe7b70fbee7a7f0e2e1e19df7579e5d880c753d/avatar",
    "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
  },
  "include_due_assignments": true,
  "entries_count": 1,
  "entries_url": "https://3.basecampapi.com/195539477/schedules/1069479396/entries.json"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/schedules/2.json

Update a schedule

  • PUT /schedules/2.json allows changing the schedule with an ID of 2.

Required parameters:

  • include_due_assignments - whether the schedule should include due dates from to-dos, cards and steps.

This endpoint will return 200 OK with the current JSON representation of the schedule if the update was a success.

Example JSON Request
{
  "schedule": {
    "include_due_assignments": false
  }
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"schedule": {"include_due_assignments": false}}' -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/schedules/2.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.