Skip to content

Sync API docs from bc3: starred alongside bookmarked on projects #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremy merged 1 commit into from
Sep 1, 2026
Merged

Sync API docs from bc3: starred alongside bookmarked on projects #441

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions sections/projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- START GET /projects.json -->
```json
Expand Down Expand Up @@ -164,7 +166,8 @@ _Optional parameters_:
}
},
"all_access": false,
"bookmarked": false
"bookmarked": false,
"starred": false
},
{
"id": 2085958506,
Expand Down Expand Up @@ -311,7 +314,8 @@ _Optional parameters_:
}
},
"all_access": false,
"bookmarked": false
"bookmarked": false,
"starred": false
}
]
```
Expand All @@ -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
<!-- START GET /projects/1.json -->
```json
Expand Down Expand Up @@ -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
}
```
<!-- END GET /projects/1.json -->
Expand Down