orgs

List pending organization invitations

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

This endpoint is not available for Enterprise Managed User (EMU) organizations.

get/orgs/{org}/invitations

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/invitations
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Query parameters

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

role'all' | 'admin' | 'direct_member' | 'billing_manager' | 'hiring_manager'

Filter invitations by their member role.

invitation_source'all' | 'member' | 'scim'

Filter invitations by their invitation source.

Response

Response

idinteger required
loginstring nullable required
emailstring nullable required
rolestring required
created_atstring required
failed_atstring nullable
failed_reasonstring nullable
team_countinteger required
node_idstring required
invitation_teams_urlstring required
invitation_sourcestring

Example response

[
  {
    "inviter": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "user_view_type": "public"
    },
    "node_id": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"",
    "invitation_teams_url": "\"https://api.github.com/organizations/16/invitations/1/teams\"",
    "invitation_source": "\"member\""
  }
]

Changes

No recorded changes to this operation across all 83 revisions of this API.