Skip to content
Docs

Reads an access group

GEThttps://api.vercel.com/v1/access-groups/{idOrName}
Allows to read an access group
Request
import { Vercel } from "@vercel/sdk";


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


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


  console.log(result);
}


run();
Response
{
  "teamPermissions": [],
  "entitlements": [],
  "isDsyncManaged": "false",
  "name": "my-access-group",
  "createdAt": "1588720733602",
  "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
  "updatedAt": "1588720733602",
  "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
  "membersCount": "5",
  "projectsCount": "2",
  "teamRoles": []
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
teamPermissionsarrayOptional
entitlementsarrayOptional
isDsyncManagedbooleanRequired
namestringRequired
The name of this access group.
createdAtstringRequired
Timestamp in milliseconds when the access group was created.
teamIdstringRequired
ID of the team that this access group belongs to.
updatedAtstringRequired
Timestamp in milliseconds when the access group was last updated.
accessGroupIdstringRequired
ID of the access group.
membersCountnumberRequired
Number of members in the access group.
projectsCountnumberRequired
Number of projects in the access group.
teamRolesarrayOptional
Roles that the team has in the access group.

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.
410Error