Site share links
Control how you share docs externally by managing share links for a site.
Was this helpful?
Control how you share docs externally by managing share links for a site.
Was this helpful?
Was this helpful?
Manage the lifecycle of share links for your published sites. This includes generating new links for external sharing and revoking or updating existing ones.
Type of Object, always equals to "share-link"
Unique identifier for the share-link
Name of the share link
{
"object": "share-link",
"id": "text",
"createdAt": "2025-08-26T23:19:07.272Z",
"name": "text",
"active": true,
"urls": {
"published": "https://example.com"
}
}The unique id of the organization
The unique id of the site
Identifier of the page results to fetch.
The number of results per page
OK
GET /v1/orgs/{organizationId}/sites/{siteId}/share-links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"next": {
"page": "text"
},
"count": 1,
"items": [
{
"object": "share-link",
"id": "text",
"createdAt": "2025-08-26T23:19:07.272Z",
"name": "text",
"active": true,
"urls": {
"published": "https://example.com"
}
}
]
}The unique id of the organization
The unique id of the site
Name of the share link
The share link has been created
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"
}The share link has been created
{
"object": "share-link",
"id": "text",
"createdAt": "2025-08-26T23:19:07.272Z",
"name": "text",
"active": true,
"urls": {
"published": "https://example.com"
}
}The unique id of the organization
The unique id of the site
The unique id of the share link
Site share link did not exist
Site share link has been deleted
DELETE /v1/orgs/{organizationId}/sites/{siteId}/share-links/{shareLinkId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
The unique id of the organization
The unique id of the site
The unique id of the share link
Name of the share link
The site share link has been updated
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"
}The site share link has been updated
{
"object": "share-link",
"id": "text",
"createdAt": "2025-08-26T23:19:07.272Z",
"name": "text",
"active": true,
"urls": {
"published": "https://example.com"
}
}