Collection teams
Allocate team-based permissions to your collections.
Was this helpful?
Allocate team-based permissions to your collections.
Was this helpful?
Was this helpful?
Assign entire teams to a collection for easier role and permission management. Perfect for larger organizations looking to streamline content access.
The unique id of the collection
Identifier of the page results to fetch.
The number of results per page
Listing of teams who have been added to a collection.
Listing of teams who have been added to a collection.
The unique id of the collection
The unique ID of the Team
The role of a member in an organization, null for guests
"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.
Team permission was updated
No team found with the given ID
No content
GET /v1/collections/{collectionId}/permissions/teams HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"next": {
"page": "text"
},
"count": 1,
"items": [
{
"permission": "admin",
"team": {
"object": "team",
"id": "text",
"title": "text",
"members": 1,
"spaces": 1,
"createdAt": "2025-08-26T20:54:12.033Z",
"permissions": {
"admin": true,
"view": true
}
}
}
]
}DELETE /v1/collections/{collectionId}/permissions/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
}