Site users

Manage which users can access or contribute to a docs site.

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

List all sites users permissions

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 users who can access the site.

application/json

Responseall of

get

/orgs/{organizationId}/sites/{siteId}/permissions/aggregate

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/permissions/aggregate HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Listing of users who can access the site.

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "permission": "admin",
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "origin": {
        "type": "space",
        "space": "text"
      }
    }
  ]
}