Space teams

Integrate team-based permissions for better collaboration in a space.

Assign entire teams to your spaces and streamline the process of granting or revoking access at scale, without dealing with individual user roles.

Remove a space team

delete

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

teamIdstringrequired

The unique ID of the Team

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/permissions/teams/{teamId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

205

400

404

205

No Content

The team has been removed from the space

Update a space team permission

patch

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

teamIdstringrequired

The unique ID of the Team

Body

roleone ofoptional

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/permissions/teams/{teamId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "role": "admin"
  }'

204

404

204

No Content

Team permission was updated

List space team persmissions

get

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/permissions/teams' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "permission": "admin",
      "team": {
        "object": "team",
        "id": "text",
        "title": "text",
        "members": 1,
        "spaces": 1,
        "createdAt": "2025-04-12T21:04:01.285Z"
      }
    }
  ]
}

Listing of teams who have been added to a space.