Skip to main content

invitations

Overview

Nameinvitations
TypeResource
Idgithub.teams.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_invitations_in_orgSELECTorg, team_slugThe 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.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
list_pending_invitations_legacySELECTteam_idDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.

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.