Creates an access group | Vercel REST API

APIs & SDKs

Creates an access group

POSThttps://api.vercel.com/v1/access-groups

Allows to create an access group

https://api.vercel.com/v1/access-groups

const response = await fetch('https://api.vercel.com/v1/access-groups?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "My access group",
    "projects": [
      {
        "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
        "role": "ADMIN"
      }
    ],
    "membersToAdd": []
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
  "createdAt": "1588720733602",
  "entitlements": [],
  "membersCount": "123",
  "name": "my-access-group",
  "projectsCount": "123",
  "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
  "teamPermissions": [],
  "teamRoles": [],
  "updatedAt": "1588720733602"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

namestringRequired

The name of the access group

projectsarrayOptional

membersToAddarrayOptional

List of members to add to the access group.

Response

200Success

accessGroupIdstringRequired

ID of the access group.

createdAtstringRequired

Timestamp in milliseconds when the access group was created.

entitlementsarrayRequired

membersCountnumberRequired

namestringRequired

The name of this access group.

projectsCountnumberRequired

teamIdstringRequired

ID of the team that this access group belongs to.

teamPermissionsarrayOptional

Permissions that the team has in the access group.

teamRolesarrayOptional

Roles that the team has in the access group.

updatedAtstringRequired

Timestamp in milliseconds when the access group was last updated.

Errors

400One of the provided values in the request body is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: Creates an access group (/docs/rest-api/access-groups/creates-an-access-group)

From the Vercel docs graph (built 2026-10-12T05:34:10.371Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Create an access group project — POST /v1/access-groups/{accessGroupIdOrName}/projects — Allows creation of an access group project
Update an access group — POST /v1/access-groups/{idOrName} — Allows to update an access group metadata
Reads an access group — GET /v1/access-groups/{idOrName} — Allows to read an access group
List members of an access group — GET /v1/access-groups/{idOrName}/members — List members of an access group
List access groups for a team, project or member — GET /v1/access-groups — List access groups

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/access-groups

const response = await fetch('https://api.vercel.com/v1/access-groups?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "My access group",
    "projects": [
      {
        "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
        "role": "ADMIN"
      }
    ],
    "membersToAdd": []
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
  "createdAt": "1588720733602",
  "entitlements": [],
  "membersCount": "123",
  "name": "my-access-group",
  "projectsCount": "123",
  "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
  "teamPermissions": [],
  "teamRoles": [],
  "updatedAt": "1588720733602"
}

OpenAPI Specification