failed_invitations

Creates, updates, deletes, gets or lists a failed_invitations resource.

Overview

Name	failed_invitations
Type	Resource
Id	github.orgs.failed_invitations

Fields

The following fields are returned by SELECT queries:

list_failed_invitations

Response

Name	Datatype	Description
id	integer (int64)
node_id	string	(example: "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x")
created_at	string
email	string
failed_at	string
failed_reason	string
invitation_source	string	(example: "member")
invitation_teams_url	string	(example: "https://api.github.com/organizations/16/invitations/1/teams")
inviter	object	A GitHub user. (title: Simple User)
login	string
role	string
team_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_failed_invitations	select	org	per_page, page	The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_failed_invitations

The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.

SELECT
id,
node_id,
created_at,
email,
failed_at,
failed_reason,
invitation_source,
invitation_teams_url,
inviter,
login,
role,
team_count
FROM github.orgs.failed_invitations
WHERE org = '{{ org }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;