GitHub v3 REST API

Org Membership

object

Org Membership

urlstring(uri)required

Example:https://api.github.com/orgs/octocat/memberships/defunkt

statestringrequired

The state of the member in the organization. The pending state indicates the user has not yet accepted an invitation.

Allowed values:activepending

Example:active

rolestringrequired

The user’s membership type in the organization.

Allowed values:adminmemberbilling_manager

Example:admin

organization_urlstring(uri)required

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

organizationobjectrequired

Organization Simple

Show Child Parameters
userobjectrequired

Simple User

Show Child Parameters
permissionsobject
Show Child Parameters
Example

org-pre-receive-hook

object
idinteger
namestring
enforcementstring
configuration_urlstring
allow_downstream_configurationboolean
Example

Project

object

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

owner_urlstring(uri)required

Example:https://api.github.com/repos/api-playground/projects-test

urlstring(uri)required

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

html_urlstring(uri)required

Example:https://github.com/api-playground/projects-test/projects/12

columns_urlstring(uri)required

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

idintegerrequired

Example:1002604

node_idstringrequired

Example:MDc6UHJvamVjdDEwMDI2MDQ=

namestringrequired

Name of the project

Example:Week One Sprint

bodystringrequired

Body of the project

Example:This project represents the sprint of the first week in January

numberintegerrequired

Example:1

statestringrequired

State of the project; either ‘open’ or ‘closed’

Example:open

creatorobjectrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-10T20:09:31Z

updated_atstring(date-time)required

Example:2014-03-03T18:58:10Z

organization_permissionstring

The baseline permission that all organization members have on this project. Only present if owner is an organization.

Allowed values:readwriteadminnone

privateboolean

Whether or not this project can be seen by everyone. Only present if owner is an organization.

Example

Team Simple

object

Groups of organization members that gives permissions on specified repositories.

idintegerrequired

Unique identifier of the team

Example:1

node_idstringrequired

Example:MDQ6VGVhbTE=

urlstring(uri)required

URL for the team

Example:https://api.github.com/organizations/1/team/1

members_urlstringrequired

Example:https://api.github.com/organizations/1/team/1/members{/member}

namestringrequired

Name of the team

Example:Justice League

descriptionstringrequired

Description of the team

Example:A great team.

permissionstringrequired

Permission that the team will have for its repositories

Example:admin

privacystring

The level of privacy this team should have

Example:closed

html_urlstring(uri)required

Example:https://github.com/orgs/rails/teams/core

repositories_urlstring(uri)required

Example:https://api.github.com/organizations/1/team/1/repos

slugstringrequired

Example:justice-league

ldap_dnstring

Distinguished Name (DN) that team maps to within LDAP environment

Example:uid=example,ou=users,dc=github,dc=com

Example

Team

object

Groups of organization members that gives permissions on specified repositories.

idintegerrequired
node_idstringrequired
namestringrequired
slugstringrequired
descriptionstringrequired
privacystring
permissionstringrequired
permissionsobject
Show Child Parameters
urlstring(uri)required
html_urlstring(uri)required

Example:https://github.com/orgs/rails/teams/core

members_urlstringrequired
repositories_urlstring(uri)required
parentobjectrequired

Groups of organization members that gives permissions on specified repositories.

Show Child Parameters
Example