GitHub v3 REST API

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
http://HOSTNAME/api/v3/projects/{project_id}/collaborators/{username}

Path Parameters

project_idintegerrequired
usernamestringrequired

Body

application/json
permissionstring

The permission to grant the collaborator.

Allowed values:readwriteadmin

Default:write

Example:write

Response

Response

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

Body

{}
 

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
http://HOSTNAME/api/v3/projects/{project_id}/collaborators/{username}

Path Parameters

project_idintegerrequired
usernamestringrequired

Response

Response

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

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
http://HOSTNAME/api/v3/projects/{project_id}/collaborators/{username}/permission

Path Parameters

project_idintegerrequired
usernamestringrequired

Response

application/json

Response

Project Collaborator Permission

Project Collaborator Permission

permissionstringrequired
userobject | nullrequired

Simple User

Show Child Parameters
get/projects/{project_id}/collaborators/{username}/permission
 
application/json

List project columns

get
http://HOSTNAME/api/v3/projects/{project_id}/columns

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

project_idintegerrequired

Response

application/json

Response

Project columns contain cards of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/367

project_urlstring(uri)required

Example:https://api.github.com/projects/120

cards_urlstring(uri)required

Example:https://api.github.com/projects/columns/367/cards

idintegerrequired

The unique identifier of the project column

Example:42

node_idstringrequired

Example:MDEzOlByb2plY3RDb2x1bW4zNjc=

namestringrequired

Name of the project column

Example:Remaining tasks

created_atstring(date-time)required

Example:2016-09-05T14:18:44Z

updated_atstring(date-time)required

Example:2016-09-05T14:22:28Z

get/projects/{project_id}/columns
 
application/json

Create a project column

post
http://HOSTNAME/api/v3/projects/{project_id}/columns

Path Parameters

project_idintegerrequired

Body

application/json
namestringrequired

Name of the project column

Example:Remaining tasks

Response

application/json

Response

Project Column

Project columns contain cards of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/367

project_urlstring(uri)required

Example:https://api.github.com/projects/120

cards_urlstring(uri)required

Example:https://api.github.com/projects/columns/367/cards

idintegerrequired

The unique identifier of the project column

Example:42

node_idstringrequired

Example:MDEzOlByb2plY3RDb2x1bW4zNjc=

namestringrequired

Name of the project column

Example:Remaining tasks

created_atstring(date-time)required

Example:2016-09-05T14:18:44Z

updated_atstring(date-time)required

Example:2016-09-05T14:22:28Z

post/projects/{project_id}/columns

Body

{ "name": "Remaining tasks" }
 
application/json