Project cards
The Projects API is currently available for developers to preview.
During the preview period, the API may change without advance notice. Please
see the blog post for full details.
To access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.inertia-preview+json
List project cards
GET /projects/columns/:column_id/cards
Response
[
{
"column_url": "https://api.github.com/projects/columns/367",
"content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
"id": 1478,
"note": "Add payload for delete Project column",
"created_at": "2016-09-05T14:21:06Z",
"updated_at": "2016-09-05T14:20:22Z"
}
]
Get a project card
GET /projects/columns/cards/:id
{
"column_url": "https://api.github.com/projects/columns/367",
"content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
"id": 1478,
"note": "Add payload for delete Project column",
"created_at": "2016-09-05T14:21:06Z",
"updated_at": "2016-09-05T14:20:22Z"
}
Create a project card
POST /projects/columns/:column_id/cards
Parameters
| Name |
Type |
Description |
note |
string |
The card's note content. Only valid for cards without another type of content, so this must be omitted if content_id and content_type are specified. |
content_id |
integer |
The id of the Issue to associate with this card. |
content_type |
string |
The type of content to associate with this card. Can only be "Issue" at this time. |
Response
{
"column_url": "https://api.github.com/projects/columns/367",
"content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
"id": 1478,
"note": "Add payload for delete Project column",
"created_at": "2016-09-05T14:21:06Z",
"updated_at": "2016-09-05T14:20:22Z"
}
Update a project card
PATCH /projects/columns/cards/:id
Parameters
| Name |
Type |
Description |
note |
string |
The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type. |
{
"column_url": "https://api.github.com/projects/columns/367",
"content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
"id": 1478,
"note": "Add payload for delete Project column",
"created_at": "2016-09-05T14:21:06Z",
"updated_at": "2016-09-05T14:20:22Z"
}
Delete a project card
DELETE /projects/columns/cards/:id
Response
Move a project card
POST /projects/columns/cards/:id/moves
Parameters
| Name |
Type |
Description |
position |
string |
Required. Can be one of top, bottom, or after:<card-id>, where <card-id> is the id value of a card in the same column, or in the new column specified by column_id. |
column_id |
integer |
The id value of a column in the same project. |
Example
{
"position": "after:3",
"column_id": 5
}
Response