Custom fonts

Bring your own fonts to personalize your documentation style.

Upload and manage custom fonts for branding or aesthetic purposes. Once added, fonts can be applied to your spaces or sites to achieve a unique look.

The CustomizationFontDefinition object

Attributes

Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.

idstringRequired

A globally unique identifier for the font definition.

custombooleanRequired

Whether the font is a custom font. If false, this font is provided by GitBook.

fontFamilystring · min: 1 · max: 50Required

The human-readable font-family name used in CSS (e.g., "Open Sans", "Playfair Display").

The CustomizationFontDefinition object

{
  "id": "text",
  "custom": true,
  "fontFamily": "text",
  "fontFaces": [
    {
      "weight": 1,
      "sources": [
        {
          "url": "https://example.com",
          "format": "woff2"
        }
      ]
    }
  ],
  "permissions": {
    "edit": true
  }
}

List all custom fonts

get

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

404

Not Found

application/json

get

/orgs/{organizationId}/fonts

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/fonts HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "custom": true,
      "fontFamily": "text",
      "fontFaces": [
        {
          "weight": 1,
          "sources": [
            {
              "url": "https://example.com",
              "format": "woff2"
            }
          ]
        }
      ],
      "permissions": {
        "edit": true
      }
    }
  ]
}

Create a custom font

put

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Defines a custom font and associated font faces with storage references.

fontFamilystring · min: 1 · max: 50Required

The human-readable font-family name used in CSS (e.g., "Open Sans", "Playfair Display").

Responses

201

Custom font created successfully.

application/json

404

Not Found

application/json

412

Invalid request data, such as missing required font weights.

application/json

put

/orgs/{organizationId}/fonts

HTTPcURLJavaScriptPython

PUT /v1/orgs/{organizationId}/fonts HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "fontFamily": "text",
  "fontFaces": [
    {
      "weight": 1,
      "storageKey": "text"
    }
  ]
}

{
  "id": "text",
  "custom": true,
  "fontFamily": "text",
  "fontFaces": [
    {
      "weight": 1,
      "sources": [
        {
          "url": "https://example.com",
          "format": "woff2"
        }
      ]
    }
  ],
  "permissions": {
    "edit": true
  }
}

Get a custom font by its ID

get

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

fontIdstringRequired

The unique ID of a font

Responses

200

Custom font.

application/json

Defines a font family along with its various font-face declarations for use in CSS '@font-face' rules.

idstringRequired

A globally unique identifier for the font definition.

custombooleanRequired

Whether the font is a custom font. If false, this font is provided by GitBook.

fontFamilystring · min: 1 · max: 50Required

The human-readable font-family name used in CSS (e.g., "Open Sans", "Playfair Display").

404

Organization or font not found.

application/json

get

/orgs/{organizationId}/fonts/{fontId}

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/fonts/{fontId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "custom": true,
  "fontFamily": "text",
  "fontFaces": [
    {
      "weight": 1,
      "sources": [
        {
          "url": "https://example.com",
          "format": "woff2"
        }
      ]
    }
  ],
  "permissions": {
    "edit": true
  }
}

Update a custom font

post

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

fontIdstringRequired

The unique ID of a font

Body

application/json

Defines a custom font and associated font faces with storage references.

fontFamilystring · min: 1 · max: 50Optional

The human-readable font-family name used in CSS (e.g., "Open Sans", "Playfair Display").

Responses

201

Custom font created successfully.

application/json

404

Not Found

application/json

412

Invalid request data, such as missing required font weights.

application/json

post

/orgs/{organizationId}/fonts/{fontId}

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/fonts/{fontId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "fontFamily": "text",
  "fontFaces": [
    {
      "weight": 1,
      "storageKey": "text"
    }
  ]
}

{
  "id": "text",
  "custom": true,
  "fontFamily": "text",
  "fontFaces": [
    {
      "weight": 1,
      "sources": [
        {
          "url": "https://example.com",
          "format": "woff2"
        }
      ]
    }
  ],
  "permissions": {
    "edit": true
  }
}

Delete a custom font

delete

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

fontIdstringRequired

The unique ID of a font

Responses

204

Organization or font not found.

205

Custom font deleted successfully.

delete

/orgs/{organizationId}/fonts/{fontId}

HTTPcURLJavaScriptPython

DELETE /v1/orgs/{organizationId}/fonts/{fontId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content