Members - GitHub Docs

This API is only available to authenticated members of the team's organization. OAuth access tokens require the read:org scope.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

List pending team invitations

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

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

get /orgs/{org}/teams/{team_slug}/invitations

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`team_slug`	string	path	team_slug parameter
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/invitations

JavaScript @octokit/core.js

await octokit.request('GET /orgs/{org}/teams/{team_slug}/invitations', {
  org: 'ORG',
  team_slug: 'TEAM_SLUG'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/teams/TEAM_SLUG/invitations

Response

Status: 200

[
  {
    "id": 1,
    "login": "monalisa",
    "node_id": "MDQ6VXNlcjE=",
    "email": "octocat@github.com",
    "role": "direct_member",
    "created_at": "2016-11-30T06:46:10-08:00",
    "failed_at": "",
    "failed_reason": "",
    "inviter": {
      "login": "other_user",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/other_user_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/other_user",
      "html_url": "https://github.com/other_user",
      "followers_url": "https://api.github.com/users/other_user/followers",
      "following_url": "https://api.github.com/users/other_user/following{/other_user}",
      "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
      "organizations_url": "https://api.github.com/users/other_user/orgs",
      "repos_url": "https://api.github.com/users/other_user/repos",
      "events_url": "https://api.github.com/users/other_user/events{/privacy}",
      "received_events_url": "https://api.github.com/users/other_user/received_events",
      "type": "User",
      "site_admin": false
    },
    "team_count": 2,
    "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams"
  }
]

Status codes

HTTP Status Code	Description
`200`	OK

Notes

Works with GitHub Apps

List team members

Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user.

get /orgs/{org}/teams/{team_slug}/members

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`team_slug`	string	path	team_slug parameter
`role`	string	query	Filters members returned by their role in the team. Can be one of: * `member` - normal members of the team. * `maintainer` - team maintainers. * `all` - all members of the team. Default: `all`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members

JavaScript @octokit/core.js

await octokit.request('GET /orgs/{org}/teams/{team_slug}/members', {
  org: 'ORG',
  team_slug: 'TEAM_SLUG'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/teams/TEAM_SLUG/members

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Status codes

HTTP Status Code	Description
`200`	OK

Notes

Works with GitHub Apps

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 see Create a team.

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

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`team_slug`	string	path	team_slug parameter
`username`	string	path

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

JavaScript @octokit/core.js

await octokit.request('GET /orgs/{org}/teams/{team_slug}/memberships/{username}', {
  org: 'ORG',
  team_slug: 'TEAM_SLUG',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

Response if user is a team maintainer

Status: 200

{
  "url": "https://api.github.com/teams/1/memberships/octocat",
  "role": "maintainer",
  "state": "active"
}

Status codes

HTTP Status Code	Description
`200`	OK
`404`	if user has no team membership

Notes

Works with GitHub Apps

Add or update team membership for a user

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

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

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

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`team_slug`	string	path	team_slug parameter
`username`	string	path
`role`	string	body	The role that this user should have in the team. Can be one of: * `member` - a normal member of the team. * `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. Default: `member`

Code samples

Example

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

JavaScript @octokit/core.js

await octokit.request('PUT /orgs/{org}/teams/{team_slug}/memberships/{username}', {
  org: 'ORG',
  team_slug: 'TEAM_SLUG',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method PUT \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

Response if user's membership with team is now pending

Status: 200

{
  "url": "https://api.github.com/teams/1/memberships/octocat",
  "role": "member",
  "state": "pending"
}

Status codes

HTTP Status Code	Description
`200`	OK
`403`	Forbidden if team synchronization is set up
`422`	Unprocessable Entity if you attempt to add an organization to a team

Notes

Works with GitHub Apps

Remove team membership for a user

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

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

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

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`team_slug`	string	path	team_slug parameter
`username`	string	path

Code samples

Example

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

JavaScript @octokit/core.js

await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}', {
  org: 'ORG',
  team_slug: 'TEAM_SLUG',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

Response

Status: 204

Status codes

HTTP Status Code	Description
`204`	No Content
`403`	Forbidden if team synchronization is set up

Notes

Works with GitHub Apps

List pending team invitations (Legacy)

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.

get /teams/{team_id}/invitations

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/invitations

JavaScript @octokit/core.js

await octokit.request('GET /teams/{team_id}/invitations', {
  team_id: 'TEAM_ID'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/invitations

Response

Status: 200

[
  {
    "id": 1,
    "login": "monalisa",
    "node_id": "MDQ6VXNlcjE=",
    "email": "octocat@github.com",
    "role": "direct_member",
    "created_at": "2016-11-30T06:46:10-08:00",
    "failed_at": "",
    "failed_reason": "",
    "inviter": {
      "login": "other_user",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/other_user_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/other_user",
      "html_url": "https://github.com/other_user",
      "followers_url": "https://api.github.com/users/other_user/followers",
      "following_url": "https://api.github.com/users/other_user/following{/other_user}",
      "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
      "organizations_url": "https://api.github.com/users/other_user/orgs",
      "repos_url": "https://api.github.com/users/other_user/repos",
      "events_url": "https://api.github.com/users/other_user/events{/privacy}",
      "received_events_url": "https://api.github.com/users/other_user/received_events",
      "type": "User",
      "site_admin": false
    },
    "team_count": 2,
    "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams"
  }
]

Status codes

HTTP Status Code	Description
`200`	OK

Notes

Works with GitHub Apps

List team members (Legacy)

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.

Team members will include the members of child teams.

get /teams/{team_id}/members

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`role`	string	query	Filters members returned by their role in the team. Can be one of: * `member` - normal members of the team. * `maintainer` - team maintainers. * `all` - all members of the team. Default: `all`
`per_page`	integer	query	Results per page (max 100) Default: `30`
`page`	integer	query	Page number of the results to fetch. Default: `1`

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/members

JavaScript @octokit/core.js

await octokit.request('GET /teams/{team_id}/members', {
  team_id: 'TEAM_ID'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/members

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Status codes

HTTP Status Code	Description
`200`	OK
`404`	Resource not found

Notes

Works with GitHub Apps

Get team member (Legacy)

The "Get team member" endpoint (described below) is deprecated.

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user.

get /teams/{team_id}/members/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`username`	string	path

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/members/USERNAME

JavaScript @octokit/core.js

await octokit.request('GET /teams/{team_id}/members/{username}', {
  team_id: 'TEAM_ID',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/members/USERNAME

if user is a member

Status: 204

Status codes

HTTP Status Code	Description
`204`	if user is a member
`404`	if user is not a member

Notes

Works with GitHub Apps

Add team member (Legacy)

The "Add team member" endpoint (described below) is deprecated.

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

put /teams/{team_id}/members/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`username`	string	path

Code samples

Example

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/members/USERNAME

JavaScript @octokit/core.js

await octokit.request('PUT /teams/{team_id}/members/{username}', {
  team_id: 'TEAM_ID',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method PUT \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/members/USERNAME

Response

Status: 204

Status codes

HTTP Status Code	Description
`204`	No Content
`403`	Forbidden
`404`	Not Found if team synchronization is set up
`422`	Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization

Notes

Works with GitHub Apps

Remove team member (Legacy)

The "Remove team member" endpoint (described below) is deprecated.

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

delete /teams/{team_id}/members/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`username`	string	path

Code samples

Example

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/members/USERNAME

JavaScript @octokit/core.js

await octokit.request('DELETE /teams/{team_id}/members/{username}', {
  team_id: 'TEAM_ID',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/members/USERNAME

Response

Status: 204

Status codes

HTTP Status Code	Description
`204`	No Content
`404`	Not Found if team synchronization is setup

Notes

Works with GitHub Apps

Get team membership for a user (Legacy)

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.

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: 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 /teams/{team_id}/memberships/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`username`	string	path

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/memberships/USERNAME

JavaScript @octokit/core.js

await octokit.request('GET /teams/{team_id}/memberships/{username}', {
  team_id: 'TEAM_ID',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/memberships/USERNAME

Response if user is a team maintainer

Status: 200

{
  "url": "https://api.github.com/teams/1/memberships/octocat",
  "role": "maintainer",
  "state": "active"
}

Status codes

HTTP Status Code	Description
`200`	OK
`404`	Resource not found

Notes

Works with GitHub Apps

Add or update team membership for a user (Legacy)

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

put /teams/{team_id}/memberships/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`username`	string	path
`role`	string	body	The role that this user should have in the team. Can be one of: * `member` - a normal member of the team. * `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. Default: `member`

Code samples

Example

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/memberships/USERNAME

JavaScript @octokit/core.js

await octokit.request('PUT /teams/{team_id}/memberships/{username}', {
  team_id: 'TEAM_ID',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method PUT \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/memberships/USERNAME

Response if user's membership with team is now pending

Status: 200

{
  "url": "https://api.github.com/teams/1/memberships/octocat",
  "role": "member",
  "state": "pending"
}

Status codes

HTTP Status Code	Description
`200`	OK
`403`	Forbidden if team synchronization is set up
`404`	Resource not found
`422`	Unprocessable Entity if you attempt to add an organization to a team

Notes

Works with GitHub Apps

Remove team membership for a user (Legacy)

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

delete /teams/{team_id}/memberships/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`team_id`	integer	path
`username`	string	path

Code samples

Example

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/teams/TEAM_ID/memberships/USERNAME

JavaScript @octokit/core.js

await octokit.request('DELETE /teams/{team_id}/memberships/{username}', {
  team_id: 'TEAM_ID',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  /teams/TEAM_ID/memberships/USERNAME

Response

Status: 204

Status codes

HTTP Status Code	Description
`204`	No Content
`403`	if team synchronization is set up

Notes

Works with GitHub Apps