REST API endpoints for Project (classic) cards

Note

The REST API to manage projects (classic) only supports authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."

Get a project card

Gets information about a project card.

Fine-grained access tokens for "Get a project card"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Projects" repository permissions (read)
"Projects" organization permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Get a project card"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`card_id` integer Required The unique identifier of the card.

HTTP response status codes for "Get a project card"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "Get a project card"

Request example

get/projects/columns/cards/{card_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/cards/CARD_ID

Response

Status: 200

{
  "url": "https://HOSTNAME/projects/columns/cards/1478",
  "id": 1478,
  "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
  "note": "Add payload for delete Project column",
  "creator": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2016-09-05T14:21:06Z",
  "updated_at": "2016-09-05T14:20:22Z",
  "archived": false,
  "column_url": "https://HOSTNAME/projects/columns/367",
  "content_url": "https://HOSTNAME/repos/api-playground/projects-test/issues/3",
  "project_url": "https://HOSTNAME/projects/120"
}

Update an existing project card

Fine-grained access tokens for "Update an existing project card"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Parameters for "Update an existing project card"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`card_id` integer Required The unique identifier of the card.

Body parameters
Name, Type, Description
`note` string or null The project card's note
`archived` boolean Whether or not the card is archived

HTTP response status codes for "Update an existing project card"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Update an existing project card"

Request example

patch/projects/columns/cards/{card_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/cards/CARD_ID \
  -d '{"note":"Add payload for delete Project column"}'

Response

Status: 200

{
  "url": "https://HOSTNAME/projects/columns/cards/1478",
  "id": 1478,
  "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
  "note": "Add payload for delete Project column",
  "creator": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2016-09-05T14:21:06Z",
  "updated_at": "2016-09-05T14:20:22Z",
  "archived": false,
  "column_url": "https://HOSTNAME/projects/columns/367",
  "content_url": "https://HOSTNAME/repos/api-playground/projects-test/issues/3",
  "project_url": "https://HOSTNAME/projects/120"
}

Delete a project card

Deletes a project card

Fine-grained access tokens for "Delete a project card"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Parameters for "Delete a project card"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`card_id` integer Required The unique identifier of the card.

HTTP response status codes for "Delete a project card"

Status code	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "Delete a project card"

Request example

delete/projects/columns/cards/{card_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/cards/CARD_ID

Response

Status: 204

Move a project card

Fine-grained access tokens for "Move a project card"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Parameters for "Move a project card"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`card_id` integer Required The unique identifier of the card.

Body parameters
Name, Type, Description
`position` string Required The position of the card in a column. Can be one of: `top`, `bottom`, or `after:<card_id>` to place after the specified card.
`column_id` integer The unique identifier of the column the card should be moved to

HTTP response status codes for "Move a project card"

Status code	Description
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.
`503`	Service Unavailable

Code samples for "Move a project card"

Request example

post/projects/columns/cards/{card_id}/moves

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/cards/CARD_ID/moves \
  -d '{"column_id":42,"position":"bottom"}'

Response

Status: 201

List project cards

Lists the project cards in a project.

Fine-grained access tokens for "List project cards"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Projects" repository permissions (read)
"Projects" organization permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List project cards"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`column_id` integer Required The unique identifier of the column.

Query parameters
Name, Type, Description
`archived_state` string Filters the project cards that are returned by the card's state. Default: `not_archived` Can be one of: `all`, `archived`, `not_archived`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

HTTP response status codes for "List project cards"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "List project cards"

Request example

get/projects/columns/{column_id}/cards

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID/cards

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/projects/columns/cards/1478",
    "id": 1478,
    "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
    "note": "Add payload for delete Project column",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2016-09-05T14:21:06Z",
    "updated_at": "2016-09-05T14:20:22Z",
    "archived": false,
    "column_url": "https://HOSTNAME/projects/columns/367",
    "content_url": "https://HOSTNAME/repos/api-playground/projects-test/issues/3",
    "project_url": "https://HOSTNAME/projects/120"
  }
]

Create a project card

Fine-grained access tokens for "Create a project card"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Projects" repository permissions (write)
"Projects" organization permissions (write)

Parameters for "Create a project card"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`column_id` integer Required The unique identifier of the column.

Body parameters
Name, Type, Description
`note` string or null Required The project card's note
`content_id` integer Required The unique identifier of the content associated with the card
`content_type` string Required The piece of content associated with the card

HTTP response status codes for "Create a project card"

Status code	Description
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed
`503`	Service Unavailable

Code samples for "Create a project card"

Request example

post/projects/columns/{column_id}/cards

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/projects/columns/COLUMN_ID/cards \
  -d '{"note":"Add payload for delete Project column"}'

Response

Status: 201

{
  "url": "https://HOSTNAME/projects/columns/cards/1478",
  "id": 1478,
  "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
  "note": "Add payload for delete Project column",
  "creator": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2016-09-05T14:21:06Z",
  "updated_at": "2016-09-05T14:20:22Z",
  "archived": false,
  "column_url": "https://HOSTNAME/projects/columns/367",
  "content_url": "https://HOSTNAME/repos/api-playground/projects-test/issues/3",
  "project_url": "https://HOSTNAME/projects/120"
}