List organization members
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
get
http://HOSTNAME/api/v3/orgs/{org}/members
Query Parameters
filterstring
Filter members returned in the list. Can be one of:
* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
* all - All members the authenticated user can see.
Allowed values:2fa_disabledall
Default:all
rolestring
Filter members returned by their role. Can be one of:
* all - All members of the organization, regardless of role.
* admin - Organization owners.
* member - Non-owner organization members.
Allowed values:alladminmember
Default:all
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
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/orgs/{org}/members
Path Parameters
Query Parameters
application/json
Check organization membership for a user
Check if a user is, publicly or privately, a member of the organization.
get
http://HOSTNAME/api/v3/orgs/{org}/members/{username}
Path Parameters
orgstringrequired
usernamestringrequired
Response
Response
Response if requester is an organization member and user is a member
get/orgs/{org}/members/{username}
Path Parameters
Remove an organization member
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization’s repositories.
delete
http://HOSTNAME/api/v3/orgs/{org}/members/{username}
Path Parameters
orgstringrequired
usernamestringrequired
Response
Response
Response
delete/orgs/{org}/members/{username}
Path Parameters
Get organization membership for a user
In order to get a user’s membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user’s membership status.
get
http://HOSTNAME/api/v3/orgs/{org}/memberships/{username}
Path Parameters
orgstringrequired
usernamestringrequired
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/orgs/{org}/memberships/{username}
Path Parameters
application/json
Set organization membership for a user
Only authenticated organization owners can add a member to the organization or update the member’s role.
-
If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user’s membership status will be
pendinguntil they accept the invitation. -
Authenticated users can update a user’s membership by passing the
roleparameter. If the authenticated user changes a member’s role toadmin, the affected user will receive an email notifying them that they’ve been made an organization owner. If the authenticated user changes an owner’s role tomember, no email will be sent.
Rate limits
To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
put
http://HOSTNAME/api/v3/orgs/{org}/memberships/{username}
Path Parameters
orgstringrequired
usernamestringrequired
Body
application/json
Body
application/json
rolestring
The role to give the user in the organization. Can be one of:
* admin - The user will become an owner of the organization.
* member - The user will become a non-owner member of the organization.
Allowed values:adminmember
Default:member
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
put/orgs/{org}/memberships/{username}
Path Parameters
Body
{}
application/json