Skip to main content

invitation_teams

Creates, updates, deletes, gets or lists an invitation_teams resource.

Overview

Nameinvitation_teams
TypeResource
Idgithub.orgs.invitation_teams

Fields

The following fields are returned by SELECT queries:

Response

NameDatatypeDescription
idinteger
namestring
enterprise_idintegerUnique identifier of the enterprise to which this team belongs
node_idstring
organization_idintegerUnique identifier of the organization to which this team belongs
descriptionstring
html_urlstring (uri) (example: https://github.com/orgs/rails/teams/core)
members_urlstring
notification_settingstring
parentobjectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
permissionstring
permissionsobject
privacystring
repositories_urlstring (uri)
slugstring
typestringThe ownership type of the team (enterprise, organization)
urlstring (uri)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_invitation_teamsselectorg, invitation_idper_page, pageList all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

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.

NameDatatypeDescription
invitation_idintegerThe unique identifier of the invitation.
orgstringThe organization name. The name is not case sensitive.
pageintegerThe page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_pageintegerThe number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

SELECT
id,
name,
enterprise_id,
node_id,
organization_id,
description,
html_url,
members_url,
notification_setting,
parent,
permission,
permissions,
privacy,
repositories_url,
slug,
type,
url
FROM github.orgs.invitation_teams
WHERE org = '{{ org }}' -- required
AND invitation_id = '{{ invitation_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;