New API parameters for project card archiving
We're adding some API parameters to support the new project card archiving feature.
Archiving and restoring a project's cards
To archive a card, use the Update a project card API endpoint, passing true
for the archived
parameter. To restore an archived card, use the same API endpoint, passing false
for the archived
parameter.
Viewing a column's archived cards
When using the List project cards API endpoint, you can now specify whether or not you'd like to see a column's archived cards. By default, you will only see cards in the column that are not archived, but if you pass "archived"
for the archived_state
parameter, you will see that column's archived cards instead. If you pass "all"
for the archived_state
parameter, you will see every card in the column, whether or not it is archived.
Preview period
To access these new parameters during the preview period, you must provide a custom media type in the Accept
header:
application/vnd.github.inertia-preview+json
During the preview period, we may change aspects of these API parameters based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.
If you have any questions or feedback, please let us know!