GET
/
v1
/
access-groups
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();
{}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectId
string

Filter access groups by project.

Example:

"prj_pavWOn1iLObbx3RowVvzmPrTWyTf"

​
search
string

Search for access groups by name.

Example:

"example"

​
membersLimit
integer

Number of members to include in the response.

Required range: 1 <= x <= 100
Example:

20

​
projectsLimit
integer

Number of projects to include in the response.

Required range: 1 <= x <= 100
Example:

20

​
limit
integer

Limit how many access group should be returned.

Required range: 1 <= x <= 100
Example:

20

​
next
string

Continuation cursor to retrieve the next page of results.

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

The response is of type object.

GET
/
v1
/
access-groups
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();
{}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectId
string

Filter access groups by project.

Example:

"prj_pavWOn1iLObbx3RowVvzmPrTWyTf"

​
search
string

Search for access groups by name.

Example:

"example"

​
membersLimit
integer

Number of members to include in the response.

Required range: 1 <= x <= 100
Example:

20

​
projectsLimit
integer

Number of projects to include in the response.

Required range: 1 <= x <= 100
Example:

20

​
limit
integer

Limit how many access group should be returned.

Required range: 1 <= x <= 100
Example:

20

​
next
string

Continuation cursor to retrieve the next page of results.

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

The response is of type object.