invitations

Overview

Name	invitations
Type	Resource
Id	github.orgs.invitations

Fields

Name	Datatype	Description
id	integer
email	string
invitation_teams_url	string
inviter	object	Simple User
login	string
failed_at	string
team_count	integer
failed_reason	string
created_at	string
role	string
node_id	string

Methods

Name	Accessible by	Required Params	Description
list_pending_invitations	SELECT	org	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, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
create_invitation	INSERT	org	Invite 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_invitation	EXEC	invitation_id, org	Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. This endpoint triggers notifications.