orgstringrequired
Get an organization membership for the authenticated user
get
{protocol}://{hostname}/api/v3/user/memberships/orgs/{org}
Path Parameters
Response
application/json
Response
application/json
Response
Org Membership
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
userobject | nullrequired
Simple User
Show Child Parameters
permissionsobject
Show Child Parameters
get/user/memberships/orgs/{org}
Path Parameters
application/json
Update an organization membership for the authenticated user
patch
{protocol}://{hostname}/api/v3/user/memberships/orgs/{org}
Path Parameters
orgstringrequired
Body
application/json
Body
application/json
statestringrequired
The state that the membership should be in. Only "active" will be accepted.
Allowed values:active
Response
application/json
Response
application/json
Response
Org Membership
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
userobject | nullrequired
Simple User
Show Child Parameters
permissionsobject
Show Child Parameters
patch/user/memberships/orgs/{org}
Path Parameters
Body
{
"state": "active"
}
application/json
List organizations for the authenticated user
List organizations for the authenticated user.
OAuth scope requirements
This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.
get
{protocol}://{hostname}/api/v3/user/orgs
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Response
application/json
Response
application/json
Response
Organization Simple
loginstringrequired
Example:github
idintegerrequired
Example:1
node_idstringrequired
Example:MDEyOk9yZ2FuaXphdGlvbjE=
urlstring(uri)required
Example:https://api.github.com/orgs/github
repos_urlstring(uri)required
Example:https://api.github.com/orgs/github/repos
events_urlstring(uri)required
Example:https://api.github.com/orgs/github/events
hooks_urlstringrequired
Example:https://api.github.com/orgs/github/hooks
issues_urlstringrequired
Example:https://api.github.com/orgs/github/issues
members_urlstringrequired
Example:https://api.github.com/orgs/github/members{/member}
public_members_urlstringrequired
Example:https://api.github.com/orgs/github/public_members{/member}
avatar_urlstringrequired
Example:https://github.com/images/error/octocat_happy.gif
descriptionstring | nullrequired
Example:A great organization
get/user/orgs
Query Parameters
application/json
List organizations for a user
List public organization memberships for the specified user.
This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
get
{protocol}://{hostname}/api/v3/users/{username}/orgs
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
usernamestringrequired
Response
200 application/json
Response
200 application/json
Response
Organization Simple
loginstringrequired
Example:github
idintegerrequired
Example:1
node_idstringrequired
Example:MDEyOk9yZ2FuaXphdGlvbjE=
urlstring(uri)required
Example:https://api.github.com/orgs/github
repos_urlstring(uri)required
Example:https://api.github.com/orgs/github/repos
events_urlstring(uri)required
Example:https://api.github.com/orgs/github/events
hooks_urlstringrequired
Example:https://api.github.com/orgs/github/hooks
issues_urlstringrequired
Example:https://api.github.com/orgs/github/issues
members_urlstringrequired
Example:https://api.github.com/orgs/github/members{/member}
public_members_urlstringrequired
Example:https://api.github.com/orgs/github/public_members{/member}
avatar_urlstringrequired
Example:https://github.com/images/error/octocat_happy.gif
descriptionstring | nullrequired
Example:A great organization
get/users/{username}/orgs
Path Parameters
Query Parameters
200 application/json
List organization projects
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.
get
{protocol}://{hostname}/api/v3/orgs/{org}/projects
Query Parameters
statestring
Indicates the state of the projects to return. Can be either open, closed, or all.
Allowed values:openclosedall
Default:open
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
orgstringrequired
Response
application/json
Response
application/json
Response
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
bodystring | nullrequired
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
creatorobject | nullrequired
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.
get/orgs/{org}/projects
Path Parameters
Query Parameters
application/json