Skip to main content
GET
/
v1
/
access-groups
/
{idOrName}
readAccessGroup
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();
{ "teamPermissions": [ "IntegrationManager" ], "entitlements": [ "v0" ], "isDsyncManaged": true, "name": "my-access-group", "createdAt": 1588720733602, "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50", "updatedAt": 1588720733602, "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50", "membersCount": 5, "projectsCount": 2, "teamRoles": [ "DEVELOPER", "BILLING" ] }

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

Query Parameters

​
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

​
isDsyncManaged
boolean
required
​
name
string
required

The name of this access group.

Example:

"my-access-group"

​
createdAt
string
required

Timestamp in milliseconds when the access group was created.

Example:

1588720733602

​
teamId
string
required

ID of the team that this access group belongs to.

Example:

"team_123a6c5209bc3778245d011443644c8d27dc2c50"

​
updatedAt
string
required

Timestamp in milliseconds when the access group was last updated.

Example:

1588720733602

​
accessGroupId
string
required

ID of the access group.

Example:

"ag_123a6c5209bc3778245d011443644c8d27dc2c50"

​
membersCount
number
required

Number of members in the access group.

Example:

5

​
projectsCount
number
required

Number of projects in the access group.

Example:

2

​
teamPermissions
enum<string>[]
​
entitlements
enum<string>[]
​
teamRoles
string[]

Roles that the team has in the access group.

Example:
["DEVELOPER", "BILLING"]
⌘I