Get the full published profile of a site including structure and customization
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$siteIdstringRequired
The unique id of the site
Query parameters
shareKeystringOptional
For sites published via share-links, the share key is useful to resolve published URLs.
Responses
200
OK
application/json
objectstring · enumRequiredPossible values:
structureone ofRequired
or
404
No matching site found
application/json
get/orgs/{organizationId}/sites/{siteId}/published
GET /v1/orgs/{organizationId}/sites/{siteId}/published HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"object": "published-content-site",
"site": {
"object": "site",
"id": "text",
"type": "basic",
"appliedType": "basic",
"title": "text",
"icon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"hostname": "text",
"basename": "text",
"proxy": {
"origin": "text",
"target": "text"
},
"visibility": "public",
"defaultLevel": "admin",
"permissions": {
"view": true,
"access": true,
"edit": true,
"create": true,
"admin": true,
"installIntegration": true,
"viewAdaptiveSchema": true,
"editAdaptiveSchema": true
},
"published": true,
"siteSpaces": 1,
"gitSync": {
"repoName": "text",
"installationStatus": "unauthenticated",
"installationProvider": "github",
"installationId": "text",
"parentInstallationId": "text",
"url": "text",
"operation": {
"state": "running",
"direction": "export",
"startedAt": "2026-01-01T00:00:00.000Z",
"endedAt": "2026-01-01T00:00:00.000Z",
"error": "text",
"errorAction": {
"label": "text",
"url": "https://example.com"
}
},
"operationTimeout": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"lastScanAt": "2026-01-01T00:00:00.000Z",
"adaptiveContent": {
"enabled": true
},
"ads": {
"status": "pending",
"submittable": true
},
"styleguide": {
"kind": "space",
"space": "text"
},
"features": [
{
"id": "sites-adaptive-content",
"plan": "basic",
"frozen": true,
"customizations": [
"header-logo"
]
}
],
"urls": {
"location": "https://example.com",
"app": "https://example.com",
"published": "https://example.com",
"preview": "https://example.com",
"login": "https://example.com",
"logout": "https://example.com"
}
},
"structure": {
"type": "sections",
"structure": [
{
"object": "site-section",
"id": "text",
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"description": "text",
"localizedDescription": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"default": true,
"draft": true,
"path": "text",
"condition": "text",
"sectionGroup": "text",
"siteSpaces": [
{
"object": "site-space",
"id": "text",
"path": "text",
"section": "text",
"space": {
"object": "space",
"id": "text",
"title": "text",
"emoji": "🎉",
"visibility": "public",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"deletedAt": "2026-01-01T00:00:00.000Z",
"editMode": "live",
"type": "styleguide",
"mergeRules": {
"type": "inherit"
},
"urls": {
"location": "https://example.com",
"app": "https://example.com",
"published": "https://example.com",
"public": "https://example.com",
"icon": "https://example.com"
},
"organization": "text",
"parent": "text",
"language": "en",
"gitSync": {
"repoName": "text",
"installationStatus": "unauthenticated",
"installationProvider": "github",
"installationId": "text",
"parentInstallationId": "text",
"url": "text",
"operation": {
"state": "running",
"direction": "export",
"startedAt": "2026-01-01T00:00:00.000Z",
"endedAt": "2026-01-01T00:00:00.000Z",
"error": "text",
"errorAction": {
"label": "text",
"url": "https://example.com"
}
},
"operationTimeout": 1,
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"imports": [
{
"object": "import-run",
"id": "text",
"startedAt": "2026-01-01T00:00:00.000Z",
"completedAt": "2026-01-01T00:00:00.000Z",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"status": "pending",
"reason": "text",
"source": {
"type": "website",
"url": "https://example.com"
},
"target": {
"space": "text",
"changeRequest": "text",
"page": "text"
},
"site": "text",
"createdBy": "text",
"urls": {
"location": "https://example.com"
},
"pages": [
{
"id": "text",
"sourceURL": "text",
"type": "page",
"status": "complete"
}
]
}
],
"visitorAuth": {
"backend": "custom"
},
"revision": "text",
"defaultLevel": "admin",
"comments": 1,
"changeRequests": 1,
"changeRequestsOpen": 1,
"changeRequestsDraft": 1,
"internal_poweredByV2": true,
"internal_singleWebsocket": true,
"permissions": {
"view": true,
"access": true,
"admin": true,
"viewInviteLinks": true,
"edit": true,
"triggerGitSync": true,
"comment": true,
"merge": true,
"review": true,
"installIntegration": true
}
},
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"default": true,
"condition": "text",
"pageId": "text",
"draft": true,
"hasAdvancedCustomizationFeature": true,
"urls": {
"published": "https://example.com"
},
"hidden": true
}
],
"urls": {
"published": "https://example.com"
},
"icon": "gear"
}
]
},
"customizations": {
"site": {
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"headingFont": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"links": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"localizedMessage": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"link": {
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"greeting": "text",
"localizedGreeting": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"suggestions": [
"text"
],
"instructions": "text"
},
"advancedCustomization": {
"enabled": true
},
"pageActions": {
"items": [
"assistant"
]
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true,
"header": false
}
}
],
"insights": {
"trackingCookie": true
},
"updatedAt": "2026-01-01T00:00:00.000Z"
},
"siteSpaces": {
"ANY_ADDITIONAL_PROPERTY": {
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"styling": {
"theme": "clean",
"primaryColor": {
"light": "text",
"dark": "text"
},
"tint": {
"color": {
"light": "text",
"dark": "text"
}
},
"infoColor": {
"light": "text",
"dark": "text"
},
"successColor": {
"light": "text",
"dark": "text"
},
"warningColor": {
"light": "text",
"dark": "text"
},
"dangerColor": {
"light": "text",
"dark": "text"
},
"corners": "straight",
"depth": "subtle",
"links": "default",
"font": "ABCFavorit",
"headingFont": "ABCFavorit",
"monospaceFont": "FiraCode",
"icons": "regular",
"codeTheme": {
"default": {
"light": "default-light",
"dark": "default-light"
},
"openapi": {
"light": "default-light",
"dark": "default-light"
}
},
"sidebar": {
"background": "default",
"list": "default"
},
"search": "prominent"
},
"favicon": {
"icon": {
"light": "https://example.com",
"dark": "https://example.com"
}
},
"header": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"primaryLink": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"style": "link",
"to": {
"kind": "file",
"file": "text",
"space": "text"
},
"links": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
],
"condition": "text"
}
]
},
"footer": {
"logo": {
"light": "https://example.com",
"dark": "https://example.com"
},
"groups": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"links": [
{
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
}
]
}
],
"copyright": "text"
},
"announcement": {
"enabled": true,
"message": "text",
"localizedMessage": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"link": {
"title": "text",
"localizedTitle": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"to": {
"kind": "file",
"file": "text",
"space": "text"
}
},
"style": "info"
},
"themes": {
"default": "light",
"toggeable": true
},
"feedback": {
"enabled": true
},
"ai": {
"mode": "none",
"greeting": "text",
"localizedGreeting": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"suggestions": [
"text"
],
"instructions": "text"
},
"advancedCustomization": {
"enabled": true
},
"pageActions": {
"items": [
"assistant"
]
},
"externalLinks": {
"target": "self"
},
"pagination": {
"enabled": true
},
"trademark": {
"enabled": true
},
"privacyPolicy": {
"url": "https://example.com"
},
"socialPreview": {
"url": "https://example.com"
},
"socialAccounts": [
{
"platform": "twitter",
"handle": "text",
"display": {
"footer": true,
"header": false
}
}
],
"insights": {
"trackingCookie": true
},
"updatedAt": "2026-01-01T00:00:00.000Z"
}
}
},
"scripts": [
{
"script": "https://example.com",
"contentSecurityPolicy": "text",
"cookies": true
}
]
}Last updated
Was this helpful?