teams

List team members

Changed on

Get a paginated list of team members for the provided team.

get/v3/teams/{teamId}/members

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v3/teams/{teamId}/members
  • Auth: HTTP bearer

Path parameters

teamIdstring required
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

Query parameters

limitnumber

Limit how many teams should be returned

Example:20
sincenumber

Timestamp in milliseconds to only include members added since then.

Example:1540095775951
untilnumber

Timestamp in milliseconds to only include members added until then.

Example:1540095775951
searchstring

Search team members by their name, username, and email.

role'OWNER' | 'MEMBER' | 'DEVELOPER' | 'SECURITY' | 'BILLING' | 'VIEWER' | 'VIEWER_FOR_PLUS' | 'CONTRIBUTOR'

Only return members with the specified team role.

Example:OWNER
excludeProjectstring

Exclude members who belong to the specified project.

eligibleMembersForProjectIdstring

Include team members who are eligible to be members of the specified project.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Example response

{
  "members": [
    {
      "accessRequestedAt": 1588820733602,
      "avatar": "123a6c5209bc3778245d011443644c8d27dc2c50",
      "confirmed": true,
      "createdAt": 1588720733602,
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "role": "OWNER",
      "uid": "zTuNVUXEAvvnNN3IaqinkyMw",
      "username": "jane-doe"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Changes

  • 10dff3be52ffRevision changes
    • warning

      added the new AiGatewayUser enum value to the /// response property for the response status

    • info

      removed the AiGatewayApiKeyOwnedBySelf enum value from the /// response property for the response status

  • e31ea8d3c1e7Revision changes
    • warning

      added the new AiGatewayTranscriptsManager enum value to the /// response property for the response status

    • warning

      added the new AiGatewayTranscriptsViewer enum value to the /// response property for the response status