List members of an access group

APIs & SDKs

GET/__remote/api.vercel.com/v1/access-groups/{idOrName}/members

List members of an access group

Request

import { Edgenivo } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.accessGroups.listAccessGroupMembers({
    idOrName: "ag_pavWOn1iLObbXLRiwVvzmPrTWyTf",
    limit: 20,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "members": [
    {
      "avatar": "string",
      "createdAt": "string",
      "email": "[email protected]",
      "name": "Example Name",
      "teamRole": "BILLING",
      "uid": "example_id",
      "username": "string"
    }
  ],
  "pagination": {
    "count": "123",
    "next": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired

The ID or name of the Access Group.

Query parameters

limitintegerOptional

Limit how many access group members should be returned.

nextstringOptional

Continuation cursor to retrieve the next page of results.

searchstringOptional

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

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

membersarrayRequired

paginationobjectRequired

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

Request

import { Edgenivo } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.accessGroups.listAccessGroupMembers({
    idOrName: "ag_pavWOn1iLObbXLRiwVvzmPrTWyTf",
    limit: 20,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "members": [
    {
      "avatar": "string",
      "createdAt": "string",
      "email": "[email protected]",
      "name": "Example Name",
      "teamRole": "BILLING",
      "uid": "example_id",
      "username": "string"
    }
  ],
  "pagination": {
    "count": "123",
    "next": "string"
  }
}

OpenAPI Specification