Skip to main content

invitations

Overview

Nameinvitations
TypeResource
Idgithub.orgs.invitations

Fields

NameDatatypeDescription
idinteger
created_atstring
emailstring
failed_atstring
failed_reasonstring
invitation_sourcestring
invitation_teams_urlstring
inviterobjectA GitHub user.
loginstring
node_idstring
rolestring
team_countinteger

Methods

NameAccessible byRequired ParamsDescription
list_pending_invitationsSELECTorgThe 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 member, the login field in the return hash will be null.
create_invitationINSERTorgInvite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
cancel_invitationEXECinvitation_id, orgCancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers notifications.