Basecamp 5 API: availability + compatibility update

[jeremy]

Basecamp 5 is rolling out, and its API is a superset of the Basecamp 4 API you already use — existing integrations keep working, and a batch of new resources is now available and documented.

New API resources

• Calendars
• Card table wormholes
• Cloud files
• Everything — account-wide feeds of files, boosts, and more
• Google documents
• My notes

Updated

• README links the new sections.
• All existing sections refreshed with regenerated JSON examples that match live Basecamp 5 API responses.
• AGENTS.md now documents this repo's role: a sync target mirroring the authoritative docs in bc3; content changes land there and arrive here via sync.

Compatibility

The BC4 wire format is preserved: response shapes, routes, and parameters documented here continue to behave as before. No breaking changes.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 431c057392

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[Copilot]

Pull request overview

Syncs this docs-only Basecamp API repo with the post-BC5-merge-train doc/api/ output from bc3, updating existing resource docs and adding new BC5 resources so the endpoint index + examples match current API behavior.

Changes:

• Added new BC5 documentation sections (Calendars, Card table wormholes, Cloud files, Everything, Google documents, My Notes).
• Regenerated JSON examples across many existing sections (new fields, updated URLs/IDs/timestamps, richer attachment fields).
• Updated specific endpoint docs to reflect BC5 API behavior changes (e.g., search parameters, webhook event types).

Tip

If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.

Reviewed changes

Copilot reviewed 55 out of 56 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
README.md	Adds links for newly documented BC5 sections in the endpoint index.
sections/account.md	Regenerated account JSON examples.
sections/attachments.md	Updates attachment upload/preview/download URLs + IDs in examples.
sections/boosts.md	Updates boost examples and adds event-boost example payload.
sections/calendars.md	New BC5 calendar resource docs + examples.
sections/card_table_columns.md	Regenerated column examples (IDs/URLs/people fields).
sections/card_table_steps.md	Adds BC5 note about canonical flat (top-level) step routes.
sections/card_table_wormholes.md	New wormhole endpoints documentation.
sections/chatbots.md	Updates chatbot examples (shape + IDs/URLs).
sections/client_approvals.md	Regenerated examples for approvals + nested response data.
sections/client_correspondences.md	Regenerated correspondences examples and related URLs/IDs.
sections/client_replies.md	Regenerated client reply examples and added attachments arrays.
sections/cloud_files.md	New BC5 cloud file resource docs + examples.
sections/comments.md	Regenerated comment examples and added content_attachments.
sections/everything.md	New BC5 “Everything” endpoint docs (account-wide listing).
sections/forwards.md	Regenerated inbox forward examples and added attachments arrays.
sections/google_documents.md	New BC5 Google document resource docs + examples.
sections/hill_charts.md	Regenerated hill chart example URLs/IDs.
sections/inbox_replies.md	Regenerated reply examples and added attachments arrays.
sections/inboxes.md	Regenerated inbox examples (IDs/URLs/people fields).
sections/lineup_markers.md	Updates lineup marker example payload fields/values.
sections/message_boards.md	Regenerated message board example payload.
sections/message_types.md	Regenerated message type examples.
sections/my_notes.md	New BC5 singleton “My Notes” resource docs + examples.
sections/out_of_office.md	Updates out-of-office example payload (adds avatar_url, back_on_date).
sections/people.md	Regenerated people examples and preferences fields.
sections/question_answers.md	Regenerated question answer examples and added attachments arrays.
sections/question_reminders.md	Regenerated question reminder examples and question payload changes.
sections/questionnaires.md	Regenerated questionnaire examples (IDs/URLs/position).
sections/questions.md	Regenerated question examples (IDs/URLs/schedule fields).
sections/schedule_entries.md	Regenerated schedule entry examples and added attachments arrays.
sections/schedules.md	Updates schedule/tooling example (renames title to “Calendar”, new IDs).
sections/search.md	Updates search docs for BC5 parameter changes + adds deprecations/sort/since.
sections/subscriptions.md	Regenerated subscription example URLs and people payload changes.
sections/todolists.md	Regenerated todolist examples and adds description_attachments.
sections/todos.md	Regenerated todo examples and adds description_attachments + steps.
sections/todosets.md	Regenerated todoset example and adds new counts/URLs (todos, hill chart).
sections/tools.md	Regenerated tool example payload.
sections/uploads.md	Regenerated upload examples and adds description_attachments.
sections/vaults.md	Regenerated vault examples (IDs/URLs/people payload changes).
sections/webhooks.md	Adds assignment-changed webhook events and regenerates webhook examples.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

sections/card_table_wormholes.md:19

• This new section doesn’t follow the section example conventions described in AGENTS.md (START/END markers around example JSON payloads/responses). In particular, the create/update endpoints promise a JSON representation on success but don’t include an example response, and the request payload blocks aren’t wrapped in START/END PAYLOAD comments for tooling to extract/regenerate reliably.

* `POST /buckets/1/card_tables/2/wormholes.json` creates a wormhole on the card table with ID `2` in the project with ID `1`.

**Required parameters**: `destination_recording_id` — the ID of a column on another card table the requester can access.

This endpoint will return `201 Created` with the current JSON representation of the wormhole if the creation was a success, or `422 Unprocessable Entity` if the card table already holds the maximum of four wormholes.

[Copilot]

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

sections/out_of_office.md:31

• The response examples now include a back_on_date field, but the prose still says only start_date and end_date are null when out-of-office is disabled. To reflect the current response shape, the description should mention back_on_date too (and that it's null when not enabled).

[Copilot]

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated no new comments.

[jeremy]

@codex review

[Copilot]

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated no new comments.

[jeremy]

@codex review

[Copilot]

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated no new comments.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 94dfc2a854

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".