Urls

Resolve a URL to a content (space, collection, page)

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

urlstringRequired

URL to resolve

Responses

200

OK

application/json

Responseone of

or

default

Unexpected Error

application/json

get

/urls/content

HTTPcURLJavaScriptPython

GET /v1/urls/content?url=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "collection": {
    "object": "collection",
    "id": "text",
    "title": "text",
    "description": "text",
    "organization": "text",
    "parent": "text",
    "defaultLevel": "admin",
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com"
    },
    "permissions": {
      "admin": true,
      "create": true
    }
  }
}

Resolve a URL to an embed

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

urlstringRequired

URL to resolve

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/urls/embed

HTTPcURLJavaScriptPython

GET /v1/urls/embed?url=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "title": "text",
  "site": "text",
  "icon": "text",
  "type": "link"
}

Resolve a URL of a published content.

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

urlstring · uriRequired

URL to resolve

visitorAuthTokenstringOptional

JWT token generated for a visitor auth session

redirectOnErrorbooleanOptional

When true redirects the user to the authentication/fallback URL if the visitor auth token is invalid

Default: false

Responses

200

OK

application/json

Responseone of

or

404

No content found for the URL.

application/json

default

Unexpected Error

application/json

get

/urls/published

HTTPcURLJavaScriptPython

GET /v1/urls/published?url=https%3A%2F%2Fexample.com HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "target": "application",
  "redirect": "https://example.com"
}