GitHub v3 REST API

Ping an organization webhook

This will trigger a ping event to be sent to the hook.

post
{protocol}://{hostname}/api/v3/orgs/{org}/hooks/{hook_id}/pings

Path Parameters

orgstringrequired
hook_idintegerrequired

Response

Response

post/orgs/{org}/hooks/{hook_id}/pings
 

List app installations for an organization

Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

get
{protocol}://{hostname}/api/v3/orgs/{org}/installations

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

orgstringrequired

Response

200 application/json

Response

total_countintegerrequired
installationsarray[object]required

Installation

Show Child Parameters
get/orgs/{org}/installations
 
200 application/json

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
{protocol}://{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

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
 
application/json

Check organization membership for a user

Check if a user is, publicly or privately, a member of the organization.

get
{protocol}://{hostname}/api/v3/orgs/{org}/members/{username}

Path Parameters

orgstringrequired
usernamestringrequired

Response

Response if requester is an organization member and user is a member

get/orgs/{org}/members/{username}
 

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
{protocol}://{hostname}/api/v3/orgs/{org}/members/{username}

Path Parameters

orgstringrequired
usernamestringrequired

Response

Response

delete/orgs/{org}/members/{username}