Docs Agents are coming — a new way to ideate, plan, and ship docs.
Join the waitlist
PricingLog inSign up

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
all ofOptional

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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

Responses
200

OK

application/json
Responseall of
get
/orgs/{organizationId}/fonts
GET /v1/orgs/YOUR_ORGANIZATION_ID/fonts HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_API_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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

Body

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
put
/orgs/{organizationId}/fonts
PUT /v1/orgs/YOUR_ORGANIZATION_ID/fonts HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Content-Length: 68
Accept: */*

{
  "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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

fontIdstringRequired

The unique ID of a font

Responses
200

Custom font.

application/json
Responseall of
get
/orgs/{organizationId}/fonts/{fontId}
GET /v1/orgs/YOUR_ORGANIZATION_ID/fonts/YOUR_FONT_ID HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_API_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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

fontIdstringRequired

The unique ID of a font

Body

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
post
/orgs/{organizationId}/fonts/{fontId}
POST /v1/orgs/YOUR_ORGANIZATION_ID/fonts/YOUR_FONT_ID HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Content-Length: 68
Accept: */*

{
  "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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

fontIdstringRequired

The unique ID of a font

Responses
delete
/orgs/{organizationId}/fonts/{fontId}
DELETE /v1/orgs/YOUR_ORGANIZATION_ID/fonts/YOUR_FONT_ID HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_API_TOKEN
Accept: */*

No content

Last updated

Was this helpful?