GitBook Site Share Links API

openapi: 3.2.0
info:
  title: GitBook Site Share Links API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:
- name: site-share-links
  x-page-title: Site share links
  x-page-description: Control how you share docs externally by managing share links for a site.
  x-parent: sites
  description: 'Manage the lifecycle of share links for your published sites. This includes generating new links for external sharing and revoking or updating existing ones.


    {% openapi-schemas spec="gitbook" schemas="ShareLink" grouped="false" %}

    The ShareLink object

    {% endopenapi-schemas %}'
paths:
  /orgs/{organizationId}/sites/{siteId}/share-links:
    get:
      operationId: listSiteShareLinks
      summary: List all private share links for a site
      description: Returns a paginated list of share links configured for the site. Share links grant access to a private site without requiring full authentication. Use this to audit existing share links, check their active status, or find a link ID before updating or revoking it.
      x-gitbook-mcp: true
      tags:
      - site-share-links
      security:
      - user: []
      - oauth:
        - site:auth:read
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/listPage'
      - $ref: '#/components/parameters/listLimit'
      - name: search
        in: query
        description: Search share links by name or key
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/List'
                - type: object
                  required:
                  - items
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/ShareLink'
    post:
      operationId: createSiteShareLink
      summary: Create a private share link for a site
      description: Creates a new named share link that grants access to the private site without requiring full user authentication. Share links are useful for sharing pre-publication content with reviewers or stakeholders. Each link has a unique key and can be activated or deactivated independently.
      x-gitbook-mcp: true
      tags:
      - site-share-links
      security:
      - user: []
      - oauth:
        - site:auth:write
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  $ref: '#/components/schemas/ShareLinkName'
              required:
              - name
      responses:
        '201':
          description: The share link has been created
          headers:
            Location:
              description: API URL for the newly created share link
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareLink'
  /orgs/{organizationId}/sites/{siteId}/share-links/{shareLinkId}:
    patch:
      operationId: updateSiteShareLinkById
      summary: Update a private share link for a site
      description: Updates a share link's properties. Use this to temporarily disable a share link without losing its configuration.
      x-gitbook-mcp: true
      tags:
      - site-share-links
      security:
      - user: []
      - oauth:
        - site:auth:write
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/shareLinkId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
              properties:
                active:
                  type: boolean
                name:
                  $ref: '#/components/schemas/ShareLinkName'
      responses:
        '200':
          description: The site share link has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareLink'
    delete:
      operationId: deleteSiteShareLinkById
      summary: Deletes a share link
      tags:
      - site-share-links
      security:
      - user: []
      - oauth:
        - site:auth:write
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/shareLinkId'
      responses:
        '204':
          description: Site share link did not exist
        '205':
          description: Site share link has been deleted
components:
  schemas:
    ShareLink:
      type: object
      properties:
        object:
          type: string
          description: Type of Object, always equals to "share-link"
          enum:
          - share-link
        id:
          type: string
          description: Unique identifier for the share-link
        createdAt:
          $ref: '#/components/schemas/Timestamp'
        name:
          $ref: '#/components/schemas/ShareLinkName'
        active:
          type: boolean
        urls:
          type: object
          description: URLs associated with the object
          properties:
            published:
              type: string
              description: URL of the published version of the share-link.
              format: uri
      required:
      - object
      - id
      - createdAt
      - urls
    Timestamp:
      type: string
      format: date-time
    List:
      type: object
      properties:
        next:
          type: object
          properties:
            page:
              type: string
              description: Unique identifier to query the next results page
          required:
          - page
        count:
          type: number
          description: Total count of objects in the list
    EntityId:
      type: string
      pattern: ^[a-zA-Z0-9_-]+$
      description: A unique entity identifier
    ShareLinkName:
      type: string
      description: Name of the share link
      minLength: 0
      maxLength: 50
  parameters:
    listLimit:
      name: limit
      in: query
      description: The number of results per page
      schema:
        type: number
        minimum: 0
        maximum: 1000
    siteId:
      name: siteId
      in: path
      required: true
      description: The unique id of the site
      schema:
        type: string
    listPage:
      name: page
      in: query
      description: Identifier of the page results to fetch.
      schema:
        type: string
    shareLinkId:
      name: shareLinkId
      in: path
      required: true
      description: The unique id of the share link
      schema:
        type: string
    organizationId:
      name: organizationId
      in: path
      required: true
      description: The unique id of the organization
      schema:
        $ref: '#/components/schemas/EntityId'
  securitySchemes:
    user:
      type: http
      scheme: bearer
    user-internal:
      type: http
      scheme: bearer
    user-staff:
      type: http
      scheme: bearer
    integration:
      type: http
      scheme: bearer
    integration-installation:
      type: http
      scheme: bearer
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.gitbook.com/authorize
          tokenUrl: https://oauth.gitbook.com/token
          scopes:
            user:read: Read your GitBook user profile.
            organization:read: Read the organizations you belong to, their settings and metadata, and their AI agent conversations.
            organization:write: Create organizations, and update organization settings and AI agent conversations.
            organization:members:read: Read organization members, teams, invites and link invites.
            organization:members:write: Manage organization members, teams, invites and link invites.
            organization:ask: Ask AI questions across an organization's content.
            organization:search: Search across an organization's content.
            space:read: Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.
            space:write: Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.
            space:permissions:read: Read the users and teams who have access to spaces and collections.
            space:permissions:write: Manage who has access to spaces and collections, including inviting users and teams.
            change-request:merge: Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.
            site:read: Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.
            site:write: Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.
            site:publish: Publish and unpublish sites, controlling their public exposure.
            site:permissions:read: Read the users and teams who have access to sites.
            site:permissions:write: Manage who has access to sites, including inviting users and teams.
            site:auth:read: Read how visitors authenticate on a site and its security configuration, including private share links.
            site:auth:write: Manage how visitors authenticate on a site and its security configuration, including private share links.
            site:insights:read: Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.
            site:ask: Ask AI questions across a site's content.
            site:search: Search across a site's content.
            integration:read: Read integrations, their status and where they are installed.
            integration:installations:read: Read integration installations and their configuration, which can include credentials for third-party services.
            integration:installations:write: Install and configure integrations on an organization, its spaces and its sites.
            integration:publish: Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.
            integration:delete: Unpublish integrations, permanently deleting them and every installation of them.
            openapi:read: Read OpenAPI specifications.
            openapi:write: Create, update and delete OpenAPI specifications.
x-provenance:
  method: harvested
  publisher: GitBook
  source: https://api.gitbook.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)