# GitBook Collection Permissions API

**Canonical:** https://apis.io/apis/gitbook/gitbook-collection-permissions-api/  
**Provider:** GitBook — https://apis.io/providers/gitbook/  
**Documentation:** https://docs.gitbook.com/developers

GitBook Collection Permissions API is one of 65 APIs that [GitBook](https://apis.io/providers/gitbook/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 7 JSON Schema definitions. Tagged areas include collection-permissions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 7 JSON Schemas.

Control which users and teams have access to a collection's spaces. This ensures only the right individuals can view or modify sensitive content.

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| POST | `/collections/{collectionId}/permissions` | Invite to a collection |
| GET | `/collections/{collectionId}/permissions/teams` | List an org team's permission in collection |
| PATCH | `/collections/{collectionId}/permissions/teams/{teamId}` | Update an org team's permission in a collection |
| DELETE | `/collections/{collectionId}/permissions/teams/{teamId}` | Remove an org team from a collection |
| GET | `/collections/{collectionId}/permissions/users` | List collection user permissions |
| PATCH | `/collections/{collectionId}/permissions/users/{userId}` | Update a collection user permission |
| DELETE | `/collections/{collectionId}/permissions/users/{userId}` | Remove a user from a collection |

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-collection-permissions-api-openapi.yml
- **Documentation** — https://docs.gitbook.com/developers
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/asyncapi/gitbook-gitbook-api-asyncapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/organization.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/space.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/page.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/user.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/change-request.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/docs-site.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/collection.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-ld/gitbook-context.jsonld

## Other GitBook APIs (12)

- [GitBook Change Request Content API](https://apis.io/apis/gitbook/gitbook-change-request-content-api/)
- [GitBook Change Request Reviewers API](https://apis.io/apis/gitbook/gitbook-change-request-reviewers-api/)
- [GitBook Change Requests API](https://apis.io/apis/gitbook/gitbook-change-requests-api/)
- [GitBook Collections API](https://apis.io/apis/gitbook/gitbook-collections-api/)
- [GitBook Custom Hostnames API](https://apis.io/apis/gitbook/gitbook-custom-hostnames-api/)
- [GitBook Imports API](https://apis.io/apis/gitbook/gitbook-imports-api/)
- [GitBook Integrations API](https://apis.io/apis/gitbook/gitbook-integrations-api/)
- [GitBook Organization Members API](https://apis.io/apis/gitbook/gitbook-organization-members-api/)
- [GitBook Organizations API](https://apis.io/apis/gitbook/gitbook-organizations-api/)
- [GitBook Site Spaces API](https://apis.io/apis/gitbook/gitbook-site-spaces-api/)
- [GitBook Space Content API](https://apis.io/apis/gitbook/gitbook-space-content-api/)
- [GitBook Spaces API](https://apis.io/apis/gitbook/gitbook-spaces-api/)

## Tags

collection-permissions

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gitbook/gitbook-collection-permissions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gitbook/.