The 2026 State of Docs survey is live 📝 Whether you write, edit, or just rely on docs, we want to hear from you!
Take the survey
PricingLog inSign up

Site permissions

Manage which members and teams can access or contribute to a docs site.

Invite, remove, or update users and teams permissions for a site. This provides a way to tightly control collaboration and visibility among your teammates.

Invite a user or a team to a site

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Body
rolestring · enumRequired

Role to set.

Possible values:
Responses
204
OK
post
POST /v1/orgs/{organizationId}/sites/{siteId}/permissions HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "role": "admin",
  "teams": [
    "text"
  ]
}
No content

List an org team's permission in a site

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

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 site.
application/json
Responseall of
get
GET /v1/orgs/{organizationId}/sites/{siteId}/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": "2026-02-18T11:55:12.893Z",
        "permissions": {
          "admin": true,
          "view": true
        }
      }
    }
  ]
}

Remove an org team from a site

delete
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

teamIdstringRequired

The unique ID of the Team

Responses
204
The team was not found in the site
delete
DELETE /v1/orgs/{organizationId}/sites/{siteId}/permissions/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update an org team's permission in a site

patch
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

teamIdstringRequired

The unique ID of the Team

Body
rolestring · enumOptional

"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
patch
PATCH /v1/orgs/{organizationId}/sites/{siteId}/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

Last updated

Was this helpful?