Collection teams

Allocate team-based permissions to your collections.

Assign entire teams to a collection for easier role and permission management. Perfect for larger organizations looking to streamline content access.

List a collection team permissions

get

Authorizations

Path parameters

collectionIdstringRequired

The unique id of the collection

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

Listing of teams who have been added to a collection.

application/json

Responseall of

get

GET /v1/collections/{collectionId}/permissions/teams HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Listing of teams who have been added to a collection.

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "permission": "admin",
      "team": {
        "object": "team",
        "id": "text",
        "title": "text",
        "members": 1,
        "spaces": 1,
        "createdAt": "2025-05-05T07:15:34.518Z",
        "permissions": {
          "admin": true,
          "view": true
        }
      }
    }
  ]
}

Remove a team from a collection

delete

Authorizations

Path parameters

collectionIdstringRequired

The unique id of the collection

teamIdstringRequired

The unique ID of the Team

Responses

205

The team has been removed from the collection

404

No team found with the given ID

application/json

delete

DELETE /v1/collections/{collectionId}/permissions/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a collection team permission

patch

Authorizations

Path parameters

collectionIdstringRequired

The unique id of the collection

teamIdstringRequired

The unique ID of the Team

Body

roleone ofOptional

The role of a member in an organization, null for guests

string · enum | nullableOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

Responses

204

Team permission was updated

404

No team found with the given ID

application/json

patch

PATCH /v1/collections/{collectionId}/permissions/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}

No content

Was this helpful?