APIs.io Engineering Platform Projects API

Interact with GitHub Projects.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 25 operations across 14 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

25 operations 14 paths 9 schemas 4 DELETE10 GET3 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Projects API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 25

Across 14 paths, the API surfaces 25 operations — 4 DELETE, 10 GET, 3 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 25

Interact with GitHub Projects.

GET

/orgs/{org}/projects

APIs.io Engineering Platform List organization projects

projects/list-for-org 4 params → 200422

POST

/orgs/{org}/projects

APIs.io Engineering Platform Create an organization project

projects/create-for-org 1 param body → 201401403404410422

GET

/projects/columns/cards/{card_id}

APIs.io Engineering Platform Get a project card

projects/get-card 1 param → 200304403401404

PATCH

/projects/columns/cards/{card_id}

APIs.io Engineering Platform Update an existing project card

projects/update-card 1 param body → 200304403401404422

DELETE

/projects/columns/cards/{card_id}

APIs.io Engineering Platform Delete a project card

projects/delete-card 1 param → 204304403401404

POST

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

APIs.io Engineering Platform Move a project card

projects/move-card 1 param body → 201304403401503422

GET

/projects/columns/{column_id}

APIs.io Engineering Platform Get a project column

projects/get-column 1 param → 200304403404401

PATCH

/projects/columns/{column_id}

APIs.io Engineering Platform Update an existing project column

projects/update-column 1 param body → 200304403401

DELETE

/projects/columns/{column_id}

APIs.io Engineering Platform Delete a project column

projects/delete-column 1 param → 204304403401

GET

/projects/columns/{column_id}/cards

APIs.io Engineering Platform List project cards

projects/list-cards 4 params → 200304403401

POST

/projects/columns/{column_id}/cards

APIs.io Engineering Platform Create a project card

projects/create-card 1 param body → 201304403401422503

POST

/projects/columns/{column_id}/moves

APIs.io Engineering Platform Move a project column

projects/move-column 1 param body → 201304403422401

GET

/projects/{project_id}

APIs.io Engineering Platform Get a project

projects/get 1 param → 200304403401

PATCH

/projects/{project_id}

APIs.io Engineering Platform Update a project

projects/update 1 param body → 200404304403401410422

DELETE

/projects/{project_id}

APIs.io Engineering Platform Delete a project

projects/delete 1 param → 204304403401410404

GET

/projects/{project_id}/collaborators

APIs.io Engineering Platform List project collaborators

projects/list-collaborators 4 params → 200404422304403401

PUT

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

APIs.io Engineering Platform Add project collaborator

projects/add-collaborator 2 params body → 204404422304403401

DELETE

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

APIs.io Engineering Platform Remove user as a collaborator

projects/remove-collaborator 2 params → 204304404403422401

GET

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

APIs.io Engineering Platform Get project permission for a user

projects/get-permission-for-user 2 params → 200404422304403401

GET

/projects/{project_id}/columns

APIs.io Engineering Platform List project columns

projects/list-columns 3 params → 200304403401

POST

/projects/{project_id}/columns

APIs.io Engineering Platform Create a project column

projects/create-column 1 param body → 201304403422401

GET

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

APIs.io Engineering Platform List repository projects

projects/list-for-repo 5 params → 200401403404410422

POST

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

APIs.io Engineering Platform Create a repository project

projects/create-for-repo 2 params body → 201401403404410422

POST

/user/projects

APIs.io Engineering Platform Create a user project

projects/create-for-authenticated-user body → 201304403401422

GET

/users/{username}/projects

APIs.io Engineering Platform List user projects

projects/list-for-user 4 params → 200422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are nullable-simple-user (21 properties), simple-user (21 properties), project (15 properties), project-card (13 properties). Each schema is shown below with its type and property counts.

nullable-simple-user

object

A GitHub user.

21 properties 18 required

project-collaborator-permission

object

Project Collaborator Permission

2 properties 2 required

basic-error

object

Basic Error

4 properties

project-column

object

Project columns contain cards of work.

8 properties 8 required

validation-error

object

Validation Error

3 properties 2 required

validation-error-simple

object

Validation Error Simple

3 properties 2 required

simple-user

object

A GitHub user.

21 properties 18 required

project-card

object

Project cards represent a scope of work.

13 properties 9 required

project

object

Projects are a way to organize columns and cards of work.

15 properties 13 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Projects

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Projects API

Metadata

Authentication & Security 1

Paths & Operations 25

Schemas 9

Specification

Source

API Details

Provider

Explore more