From d3cf55a3d6b7fcce7039a2078b42e5bfc726204c Mon Sep 17 00:00:00 2001 From: Jeremy Daer Date: Mon, 31 Aug 2026 21:00:38 -0700 Subject: [PATCH] Sync API docs from bc3: starred alongside bookmarked on projects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Projects now expose `starred` next to `bookmarked`, per basecamp/bc3#13042. `bookmarked` is true whenever the project is pinned to the current user's home page (starred or filed into a stack); `starred` only when it carries a star. Both example payloads on Get all projects and Get a project gain the field, and Get a project's example now shows `bookmarked` too. Synced from bc3 `doc/api/` by `script/api/sync_to_bc3_api` — not a hand-edit. --- sections/projects.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/sections/projects.md b/sections/projects.md index 89be18e..835a27d 100644 --- a/sections/projects.md +++ b/sections/projects.md @@ -20,6 +20,8 @@ _Optional parameters_: * `status` - set to `active`, `archived`, or `trashed` to filter projects by status. +Two flags describe the project's place on the current user's home page: `bookmarked` is `true` when the project is pinned there at all, whether starred or filed into a stack, and `starred` is `true` only when it carries a star. + ###### Example JSON Response ```json @@ -164,7 +166,8 @@ _Optional parameters_: } }, "all_access": false, - "bookmarked": false + "bookmarked": false, + "starred": false }, { "id": 2085958506, @@ -311,7 +314,8 @@ _Optional parameters_: } }, "all_access": false, - "bookmarked": false + "bookmarked": false, + "starred": false } ] ``` @@ -330,6 +334,8 @@ Get a project The `dock` key contains an array of the current tools for this project. The `enabled` flag will be `true` if the tool is turned on for use. You can use the `url` parameter from each tool to jump to the resources available inside of this project. +`bookmarked` and `starred` reflect the current user's home page, as in [Get all projects](#get-projects). + ###### Example JSON Response ```json @@ -472,7 +478,9 @@ The `dock` key contains an array of the current tools for this project. The `ena ] } }, - "all_access": false + "all_access": false, + "bookmarked": false, + "starred": false } ```