Skip to content
Docs

List access groups for a team, project or member

GEThttps://api.vercel.com/v1/access-groups
List access groups
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.accessGroups.listAccessGroups({
    projectId: "prj_pavWOn1iLObbx3RowVvzmPrTWyTf",
    search: "example",
    membersLimit: 20,
    projectsLimit: 20,
    limit: 20,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
"value"

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringOptional
Filter access groups by project.
membersLimitintegerOptional
Number of members to include in the response.
projectsLimitintegerOptional
Number of projects to include in the response.
limitintegerOptional
Limit how many access group should be returned.
nextstringOptional
Continuation cursor to retrieve the next page of results.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error