v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
teams

Get team membership for a user

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.

Note: The response contains the state of the membership and the member's role.

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

get/orgs/{org}/teams/{team_slug}/memberships/{username}

Path parameters

orgstring required

The organization name. The name is not case sensitive.

team_slugstring required

The slug of the team name.

usernamestring required

The handle for the GitHub user account.

Response

Response

urlstring uri required
role'member' | 'maintainer' required

The role of the user in the team.

state'active' | 'pending' required

The state of the user's membership in the team.

Example response

{
  "role": "member"
}