List all sites users permissions
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Identifier of the page results to fetch.
The number of results per page
An order for the items in the list
descPossible values: The role to filter the list by
"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.
A query to filter the list by display name and email
The property to sort the list by
joinedAtPossible values: Team identifier. Filter the list to members of a specific team.
Listing of users who can access the site.
Total count of objects in the list
Number of users with a role in the site, guests excluded. It ignores the filters and the pagination of the request.
GET /v1/orgs/{organizationId}/sites/{siteId}/permissions/aggregate HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Listing of users who can access the site.
{
"next": {
"page": "text"
},
"count": 1,
"membersCount": 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"
},
"disabled": false,
"lastSeenAt": "2026-01-01T00:00:00.000Z"
}
]
}Last updated
Was this helpful?