GET/teams/{team_id}/memberships/{username}Deprecated

Get team membership for a user (Legacy)

[!WARNING] Endpoint closing down notice: This endpoint route is closing down 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.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

team_idintegerrequired

The unique identifier of the team.

usernamestringrequired

The handle for the GitHub user account.

2 status codes

200Response

urlstringrequired

rolestringrequired

The role of the user in the team.

Allowed:membermaintainerDefault:member

statestringrequired

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

Allowed:activepending

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.memberships.get({
  teamId: "c0a80123-4567-89ab-cdef-0123456789ab",
  username: "octocat",
});

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

Was this helpful?

Request

Response

Errors