Proyectos - GitHub Docs

List organization projects

Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

get /orgs/{org}/projects

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`org`	string	path
`state`	string	query	Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. Default: `open`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/orgs/ORG/projects

JavaScript (@octokit/core.js)

await octokit.request('GET /orgs/{org}/projects', { org: 'org' })

Response

Status: 200 OK

[ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z" } ]

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

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

Create an organization project

Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

post /orgs/{org}/projects

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`org`	string	path
`name`	string	body	Required. The name of the project.
`body`	string	body	The description of the project.

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/orgs/ORG/projects \ -d '{"name":"name"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /orgs/{org}/projects', { org: 'org', name: 'name' })

Response

Status: 201 Created

{ "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z" }

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Gone

Status: 410 Gone

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Get a project

Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

get /projects/{project_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/{project_id}', { project_id: 42 })

Response

Status: 200 OK

{ "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Update a project

Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

patch /projects/{project_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`name`	string	body	Name of the project
`body`	string or nullable	body	Body of the project
`state`	string	body	State of the project; either 'open' or 'closed'
`organization_permission`	string	body	The baseline permission that all organization members have on this project
`private`	boolean	body	Whether or not this project can be seen by everyone.

Ejemplos de código

Shell

curl \ -X PATCH \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42 \ -d '{"name":"name"}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /projects/{project_id}', { project_id: 42, name: 'name' })

Response

Status: 200 OK

{ "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Not Found if the authenticated user does not have access to the project

Status: 404 Not Found

Gone

Status: 410 Gone

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Delete a project

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

delete /projects/{project_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path

Ejemplos de código

Shell

curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42

JavaScript (@octokit/core.js)

await octokit.request('DELETE /projects/{project_id}', { project_id: 42 })

Delete Success

Status: 204 No Content

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Gone

Status: 410 Gone

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

List repository projects

Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

get /repos/{owner}/{repo}/projects

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`owner`	string	path
`repo`	string	path
`state`	string	query	Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. Default: `open`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/projects', { owner: 'octocat', repo: 'hello-world' })

Response

Status: 200 OK

[ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } ]

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Gone

Status: 410 Gone

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Create a repository project

Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

post /repos/{owner}/{repo}/projects

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`owner`	string	path
`repo`	string	path
`name`	string	body	Required. The name of the project.
`body`	string	body	The description of the project.

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/repos/octocat/hello-world/projects \ -d '{"name":"name"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /repos/{owner}/{repo}/projects', { owner: 'octocat', repo: 'hello-world', name: 'name' })

Response

Status: 201 Created

{ "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Gone

Status: 410 Gone

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Create a user project

post /user/projects

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`name`	string	body	Required. Name of the project
`body`	string or nullable	body	Body of the project

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/user/projects \ -d '{"name":"name"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /user/projects', { name: 'name' })

Response

Status: 201 Created

{ "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", "html_url": "https://github.com/users/octocat/projects/1", "columns_url": "https://api.github.com/projects/1002603/columns", "id": 1002603, "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", "name": "My Projects", "body": "A board to manage my personal projects.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Preview header missing

Status: 415 Unsupported Media Type

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

List user projects

get /users/{username}/projects

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`username`	string	path
`state`	string	query	Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. Default: `open`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/users/USERNAME/projects

JavaScript (@octokit/core.js)

await octokit.request('GET /users/{username}/projects', { username: 'username' })

Response

Status: 200 OK

[ { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", "html_url": "https://github.com/users/octocat/projects/1", "columns_url": "https://api.github.com/projects/1002603/columns", "id": 1002603, "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", "name": "My Projects", "body": "A board to manage my personal projects.", "number": 1, "state": "open", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } ]

Validation failed

Status: 422 Unprocessable Entity

Aviso de previsualización

application/vnd.github.inertia-preview+json

Tarjetas

Get a project card

get /projects/columns/cards/{card_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`card_id`	integer	path	card_id parameter

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/cards/42

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/columns/cards/{card_id}', { card_id: 42 })

Response

Status: 200 OK

{ "url": "https://api.github.com/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://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/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://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Update an existing project card

patch /projects/columns/cards/{card_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`card_id`	integer	path	card_id parameter
`note`	string or nullable	body	The project card's note
`archived`	boolean	body	Whether or not the card is archived

Ejemplos de código

Shell

curl \ -X PATCH \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/cards/42 \ -d '{"note":"note"}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /projects/columns/cards/{card_id}', { card_id: 42, note: 'note' })

Response

Status: 200 OK

{ "url": "https://api.github.com/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://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/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://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Delete a project card

delete /projects/columns/cards/{card_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`card_id`	integer	path	card_id parameter

Ejemplos de código

Shell

curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/cards/42

JavaScript (@octokit/core.js)

await octokit.request('DELETE /projects/columns/cards/{card_id}', { card_id: 42 })

Response

Status: 204 No Content

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Move a project card

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

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`card_id`	integer	path	card_id parameter
`position`	string	body	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	body	The unique identifier of the column the card should be moved to

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/cards/42/moves \ -d '{"position":"position"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /projects/columns/cards/{card_id}/moves', { card_id: 42, position: 'position' })

Response

Status: 201 Created

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Validation failed

Status: 422 Unprocessable Entity

Response

Status: 503 Service Unavailable

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

List project cards

get /projects/columns/{column_id}/cards

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`column_id`	integer	path	column_id parameter
`archived_state`	string	query	Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. Default: `not_archived`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/42/cards

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/columns/{column_id}/cards', { column_id: 42 })

Response

Status: 200 OK

[ { "url": "https://api.github.com/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://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/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://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } ]

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Create a project card

post /projects/columns/{column_id}/cards

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`column_id`	integer	path	column_id parameter
`note`	string or nullable	body	Required. The project card's note
`content_id`	integer	body	Required. The unique identifier of the content associated with the card
`content_type`	string	body	Required. The piece of content associated with the card

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/42/cards

JavaScript (@octokit/core.js)

await octokit.request('POST /projects/columns/{column_id}/cards', { column_id: 42 })

Response

Status: 201 Created

{ "url": "https://api.github.com/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://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/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://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Validation failed

Status: 422 Unprocessable Entity

Response

Status: 503 Service Unavailable

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Colaboradores

Esta API te permite interactuar con los proyectos de una organización.

List project collaborators

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

get /projects/{project_id}/collaborators

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`affiliation`	string	query	Filters the collaborators by their affiliation. Can be one of: * `outside`: Outside collaborators of a project that are not a member of the project's organization. * `direct`: Collaborators with permissions to a project, regardless of organization membership status. * `all`: All collaborators the authenticated user can see. Default: `all`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42/collaborators

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/{project_id}/collaborators', { project_id: 42 })

Response

Status: 200 OK

[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Add project collaborator

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

put /projects/{project_id}/collaborators/{username}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`username`	string	path
`permission`	string	body	The permission to grant the collaborator. Default: `write`

Ejemplos de código

Shell

curl \ -X PUT \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME \ -d '{"permission":"permission"}'

JavaScript (@octokit/core.js)

await octokit.request('PUT /projects/{project_id}/collaborators/{username}', { project_id: 42, username: 'username', permission: 'permission' })

Response

Status: 204 No Content

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Remove user as a collaborator

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

delete /projects/{project_id}/collaborators/{username}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`username`	string	path

Ejemplos de código

Shell

curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME

JavaScript (@octokit/core.js)

await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', { project_id: 42, username: 'username' })

Response

Status: 204 No Content

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Get project permission for a user

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

get /projects/{project_id}/collaborators/{username}/permission

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`username`	string	path

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42/collaborators/USERNAME/permission

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', { project_id: 42, username: 'username' })

Response

Status: 200 OK

{ "permission": "admin", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Columnas

Get a project column

get /projects/columns/{column_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`column_id`	integer	path	column_id parameter

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/42

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/columns/{column_id}', { column_id: 42 })

Response

Status: 200 OK

{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Resource not found

Status: 404 Not Found

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Update an existing project column

patch /projects/columns/{column_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`column_id`	integer	path	column_id parameter
`name`	string	body	Required. Name of the project column

Ejemplos de código

Shell

curl \ -X PATCH \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/42 \ -d '{"name":"name"}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /projects/columns/{column_id}', { column_id: 42, name: 'name' })

Response

Status: 200 OK

{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Delete a project column

delete /projects/columns/{column_id}

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`column_id`	integer	path	column_id parameter

Ejemplos de código

Shell

curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/42

JavaScript (@octokit/core.js)

await octokit.request('DELETE /projects/columns/{column_id}', { column_id: 42 })

Response

Status: 204 No Content

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Move a project column

post /projects/columns/{column_id}/moves

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`column_id`	integer	path	column_id parameter
`position`	string	body	Required. The position of the column in a project. Can be one of: `first`, `last`, or `after:<column_id>` to place after the specified column.

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/columns/42/moves \ -d '{"position":"position"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /projects/columns/{column_id}/moves', { column_id: 42, position: 'position' })

Response

Status: 201 Created

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

List project columns

get /projects/{project_id}/columns

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Ejemplos de código

Shell

curl \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42/columns

JavaScript (@octokit/core.js)

await octokit.request('GET /projects/{project_id}/columns', { project_id: 42 })

Response

Status: 200 OK

[ { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } ]

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json

Create a project column

post /projects/{project_id}/columns

Parámetros

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.Ver aviso de previsualización
`project_id`	integer	path
`name`	string	body	Required. Name of the project column

Ejemplos de código

Shell

curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/projects/42/columns \ -d '{"name":"name"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /projects/{project_id}/columns', { project_id: 42, name: 'name' })

Response

Status: 201 Created

{ "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" }

Not modified

Status: 304 Not Modified

Requires authentication

Status: 401 Unauthorized

Forbidden

Status: 403 Forbidden

Validation failed

Status: 422 Unprocessable Entity

Notes

Works with GitHub Apps

Aviso de previsualización

application/vnd.github.inertia-preview+json