{ "opencollection": "1.0.0", "info": { "name": "Github Projects API", "version": "1.1.4" }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Organization Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "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." }, { "info": { "name": "GitHub Create an Organization Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Get a Project Card", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ] }, "docs": "Gets information about a project card." }, { "info": { "name": "GitHub Update an Existing Project Card", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update an Existing Project Card" }, { "info": { "name": "GitHub Delete a Project Card", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ] }, "docs": "Deletes a project card" }, { "info": { "name": "GitHub Move a Project Card", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id/moves", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Move a Project Card" }, { "info": { "name": "GitHub Get a Project Column", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ] }, "docs": "Gets information about a project column." }, { "info": { "name": "GitHub Update an Existing Project Column", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update an Existing Project Column" }, { "info": { "name": "GitHub Delete a Project Column", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ] }, "docs": "Deletes a project column." }, { "info": { "name": "GitHub List Project Cards", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id/cards", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." }, { "name": "archived_state", "value": "all", "type": "query", "description": "Filters the project cards that are returned by the card's state." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the project cards in a project." }, { "info": { "name": "GitHub Create a Project Card", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id/cards", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create a Project Card" }, { "info": { "name": "GitHub Move a Project Column", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id/moves", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Move a Project Column" }, { "info": { "name": "GitHub Get a Project", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "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." }, { "info": { "name": "GitHub Update a Project", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GitHub Delete a Project", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled." }, { "info": { "name": "GitHub List Project Collaborators", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "affiliation", "value": "outside", "type": "query", "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "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." }, { "info": { "name": "GitHub Add Project Collaborator", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators/:username", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "GitHub Remove User as a Collaborator", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators/:username", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator." }, { "info": { "name": "GitHub Get Project Permission for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators/:username/permission", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "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." }, { "info": { "name": "GitHub List Project Columns", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/columns", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the project columns in a project." }, { "info": { "name": "GitHub Create a Project Column", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/columns", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new project column." }, { "info": { "name": "GitHub List Repository Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/projects", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "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." }, { "info": { "name": "GitHub Create a Repository Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/projects", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Create a User Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub List User Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/projects", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists projects for a user." }, { "info": { "name": "GitHub List Team Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`." }, { "info": { "name": "GitHub Check Team Permissions for Project", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects/:project_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`." }, { "info": { "name": "GitHub Add or Update Team Project Permissions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects/:project_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`." }, { "info": { "name": "GitHub Remove Project from Team", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects/:project_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/t" }, { "info": { "name": "GitHub List Team Projects (legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team." }, { "info": { "name": "GitHub Check Team Permissions for Project (legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects/:project_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team." }, { "info": { "name": "GitHub Add or Update Team Project Permissions (legacy)", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects/:project_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The pro" }, { "info": { "name": "GitHub Remove Project from Team (legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects/:project_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user mu" } ] } ], "bundled": true }