Skip to main content

Teams

Reference documentation for GraphQL schema types in the Teams category.

Mutations

updateTeamsRepository

Mutation

Update team repository.

Input fields for updateTeamsRepository

Return fields for updateTeamsRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was updated.

teams ([Team!])

The teams granted permission on the repository.

Objects

OrganizationTeamsHovercardContext

Object

An organization teams hovercard context.

OrganizationTeamsHovercardContext Implements

Fields for OrganizationTeamsHovercardContext

NameDescription

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

Arguments for relevantTeams

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

teamsResourcePath (URI!)

The path for the full team list for this user.

teamsUrl (URI!)

The URL for the full team list for this user.

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

Team

Object

A team of users in an organization.

Team Implements

Fields for Team

NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

Arguments for ancestors

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

avatarUrl (URI)

A URL pointing to the team's avatar.

Arguments for avatarUrl

  • size (Int)

    The size in pixels of the resulting square image.

    The default value is 400.

childTeams (TeamConnection!)

List of child teams belonging to this team.

Arguments for childTeams

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • immediateOnly (Boolean)

    Whether to list immediate child teams or all descendant child teams.

    The default value is true.

  • last (Int)

    Returns the last n elements from the list.

  • userLogins ([String!])

    User logins to filter by.

combinedSlug (String!)

The slug corresponding to the organization and team.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the team.

editTeamResourcePath (URI!)

The HTTP path for editing this team.

editTeamUrl (URI!)

The HTTP URL for editing this team.

id (ID!)

The Node ID of the Team object.

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

Arguments for invitations

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

Arguments for memberStatuses

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (UserStatusOrder)

    Ordering options for user statuses returned from the connection.

members (TeamMemberConnection!)

A list of users who are members of this team.

Arguments for members

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The search string to look for.

membersResourcePath (URI!)

The HTTP path for the team' members.

membersUrl (URI!)

The HTTP URL for the team' members.

name (String!)

The name of the team.

newTeamResourcePath (URI!)

The HTTP path creating a new team.

newTeamUrl (URI!)

The HTTP URL creating a new team.

notificationSetting (TeamNotificationSetting!)

The notification setting that the team has set.

organization (Organization!)

The organization that owns this team.

parentTeam (Team)

The parent team of the team.

privacy (TeamPrivacy!)

The level of privacy the team has.

projectV2 (ProjectV2)

Finds and returns the project according to the provided project number.

Arguments for projectV2

  • number (Int!)

    The Project number.

projectsV2 (ProjectV2Connection!)

List of projects this team has collaborator access to.

Arguments for projectsV2

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • filterBy (ProjectV2Filters)

    Filtering options for projects returned from this connection.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The query to search projects by.

    The default value is .

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

Arguments for repositories

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    The search string to look for. Repositories will be returned where the name contains your search string.

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

resourcePath (URI!)

The HTTP path for this team.

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

slug (String!)

The slug corresponding to the team.

teamsResourcePath (URI!)

The HTTP path for this team's teams.

teamsUrl (URI!)

The HTTP URL for this team's teams.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this team.

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the subscribable entity.

Warning

viewerCanSubscribe is deprecated.

Team.viewerCanSubscribe will be removed. Team notifications subscriptions are being deprecated. Removal on 2026-07-01 UTC.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

Warning

viewerSubscription is deprecated.

Team.viewerSubscription will be removed. Team notifications subscriptions are being deprecated. Removal on 2026-07-01 UTC.

TeamAddMemberAuditEntry

Object

Audit log entry for a team.add_member event.

TeamAddMemberAuditEntry Implements

Fields for TeamAddMemberAuditEntry

NameDescription

action (String!)

The action name.

Warning

action is deprecated.

The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC.

actor (AuditEntryActor)

The user who initiated the action.

Warning

actor is deprecated.

The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC.

actorIp (String)

The IP address of the actor.

Warning

actorIp is deprecated.

The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Warning

actorLocation is deprecated.

The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC.

actorLogin (String)

The username of the user who initiated the action.

Warning

actorLogin is deprecated.

The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC.

actorResourcePath (URI)

The HTTP path for the actor.

Warning

actorResourcePath is deprecated.

The GraphQL audit-log is deprecated. Please use the REST API instead. Removal on 2026-04-01 UTC.

actorUrl (URI)

The HTTP URL for the actor.

Warning