Product
PricingLog inSign up

Site share links

Control how you share docs externally by managing share links for a site.

Manage the lifecycle of share links for your published sites. This includes generating new links for external sharing and revoking or updating existing ones.

Attributes
objectstring · enumRequired

Type of Object, always equals to "share-link"

Possible values:
idstringRequired

Unique identifier for the share-link

createdAtstring · date-timeRequired
namestring · max: 50Optional

Name of the share link

activebooleanOptional

The ShareLink object

{
  "object": "share-link",
  "id": "text",
  "createdAt": "2025-04-26T13:19:46.575Z",
  "name": "text",
  "active": true,
  "urls": {
    "published": "https://example.com"
  }
}

List all share links

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
Responseall of
get
GET /v1/orgs/{organizationId}/sites/{siteId}/share-links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "share-link",
      "id": "text",
      "createdAt": "2025-04-26T13:19:46.575Z",
      "name": "text",
      "active": true,
      "urls": {
        "published": "https://example.com"
      }
    }
  ]
}

Create a share link

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Body
namestring · max: 50Required

Name of the share link

Responses
post
POST /v1/orgs/{organizationId}/sites/{siteId}/share-links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
201

The share link has been created

{
  "object": "share-link",
  "id": "text",
  "createdAt": "2025-04-26T13:19:46.575Z",
  "name": "text",
  "active": true,
  "urls": {
    "published": "https://example.com"
  }
}

Deletes a share link

delete
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

shareLinkIdstringRequired

The unique id of the share link

Responses
delete
DELETE /v1/orgs/{organizationId}/sites/{siteId}/share-links/{shareLinkId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
205

Site share link has been deleted

No content

Update a share link

patch
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

shareLinkIdstringRequired

The unique id of the share link

Body
activebooleanOptional
namestring · max: 50Optional

Name of the share link

Responses
patch
PATCH /v1/orgs/{organizationId}/sites/{siteId}/share-links/{shareLinkId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "active": true,
  "name": "text"
}
200

The site share link has been updated

{
  "object": "share-link",
  "id": "text",
  "createdAt": "2025-04-26T13:19:46.575Z",
  "name": "text",
  "active": true,
  "urls": {
    "published": "https://example.com"
  }
}

Was this helpful?