access-groups

List access groups for a team, project or member

Changed on

List access groups

get/v1/access-groups

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/access-groups
  • Auth: HTTP bearer

Query parameters

projectIdstring

Filter access groups by project.

Example:prj_pavWOn1iLObbx3RowVvzmPrTWyTf
searchstring

Search for access groups by name.

Example:example
membersLimitinteger

Number of members to include in the response.

Example:20
projectsLimitinteger

Number of projects to include in the response.

Example:20
limitinteger

Limit how many access group should be returned.

Example:20
nextstring

Continuation cursor to retrieve the next page of results.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

object required
OR

Example response

{
  "accessGroups": [
    {
      "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
      "membersCount": 5,
      "name": "my-access-group",
      "projectsCount": 2,
      "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
      "teamRoles": [
        "DEVELOPER",
        "BILLING"
      ]
    }
  ]
}

Changes