Search + K

Command Palette

Search for a command to run...

Sign In

List pending team invitations (Legacy)

Deprecated
GET /teams/{team_id}/invitations
Copy endpoint
https://api.github.com

[!WARNING] Endpoint closing down notice: This endpoint route is closing down 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.

Parameters

path Path Parameters

Name Type
team_id required

The unique identifier of the team.

number

query Query Parameters

Name Type
per_page

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

number
page

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

number

Responses

200 application/json

Response

interface OrganizationInvitation {
id: number;
login: string | null;
email: string | null;
role: string;
created_at: string;
failed_at?: string | null;
failed_reason?: string | null;
inviter: SimpleUser

A GitHub user.

interface SimpleUser {
name?: string | null;
email?: string | null;
login: string;
id: number;
node_id: string;
avatar_url: string;
gravatar_id: string | null;
url: string;
html_url: string;
followers_url: string;
following_url: string;
gists_url: string;
starred_url: string;
subscriptions_url: string;
organizations_url: string;
repos_url: string;
events_url: string;
received_events_url: string;
type: string;
site_admin: boolean;
starred_at?: string;
user_view_type?: string;
}
;
team_count: number;
node_id: string;
invitation_teams_url: string;
invitation_source?: string;
}
[]