Search
K
GitHub v3 REST API

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

Query Parameters

affiliationstring

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.

Allowed values:outsidedirectall

Default:all

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

Simple User

namestring | null
emailstring | null
loginstringrequired

Example:octocat

idintegerrequired

Example:1

node_idstringrequired

Example:MDQ6VXNlcjE=

avatar_urlstring(uri)required

Example:https://github.com/images/error/octocat_happy.gif

gravatar_idstring | nullrequired

Example:41d064eb2195891e12d0413f63227ea7

urlstring(uri)required

Example:https://api.github.com/users/octocat

html_urlstring(uri)required

Example:https://github.com/octocat

followers_urlstring(uri)required

Example:https://api.github.com/users/octocat/followers

following_urlstringrequired

Example:https://api.github.com/users/octocat/following{/other_user}

gists_urlstringrequired

Example:https://api.github.com/users/octocat/gists{/gist_id}

starred_urlstringrequired

Example:https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_urlstring(uri)required

Example:https://api.github.com/users/octocat/subscriptions

organizations_urlstring(uri)required

Example:https://api.github.com/users/octocat/orgs

repos_urlstring(uri)required

Example:https://api.github.com/users/octocat/repos

events_urlstringrequired

Example:https://api.github.com/users/octocat/events{/privacy}

received_events_urlstring(uri)required

Example:https://api.github.com/users/octocat/received_events

typestringrequired

Example:User

site_adminbooleanrequired
starred_atstring

Example:"2020-07-09T00:17:55Z"

get/projects/{project_id}/collaborators
 
application/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
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