Search + K

Command Palette

Search for a command to run...

Sign In

Get team membership for a user

GET /orgs/{org}/teams/{team_slug}/memberships/{username}
Copy endpoint
https://api.github.com

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.

Parameters

path Path Parameters

Name Type
org required

The organization name. The name is not case sensitive.

string
team_slug required

The slug of the team name.

string
username required

The handle for the GitHub user account.

string

Responses

200 application/json

Response

interface TeamMembership {
url: string;
role: "member" | "maintainer";
state: "active" | "pending";
}

Client Errors

404

if user has no team membership

unknown