On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

findFonts

API reference for the findFonts method.

Retrieves a list of fonts.

Only a subset of Canva's fonts are returned.

Usage

Get a list of all available fonts

import { findFonts } from "@canva/asset";
const response = await findFonts();
TYPESCRIPT

Get a specific font

import { type FontRef, findFonts } from "@canva/asset";
const placeholderFontRef = "PLACEHOLDER_FONT_REF" as FontRef;
const response = await findFonts({
fontRefs: [placeholderFontRef]
});
TYPESCRIPT

Get multiple specific fonts

import { type FontRef, findFonts } from "@canva/asset";
const placeholderFontRef1 = "PLACEHOLDER_FONT_REF" as FontRef;
const placeholderFontRef2 = "PLACEHOLDER_FONT_REF" as FontRef;
const response = await findFonts({
fontRefs: [placeholderFontRef1, placeholderFontRef2]
});
TYPESCRIPT

Parameters

optionsFindFontsOptions
Optional

Options for retrieving a list of fonts.

fontRefsFontRef[]
Optional

The refs of the fonts to retrieve.

Returns

The result of retrieving a list of fonts. This is a Promise that resolves with the following object:

fontsFont[]

The retrieved fonts.

refFontRef

A unique identifier that points to a font asset in Canva's backend.

namestring

The name of the font.

weightsFontWeight[]

The available font weights for the font.

weightFontWeightName

The name of the font weight.

Available values:

  • "normal"
  • "thin"
  • "extralight"
  • "light"
  • "medium"
  • "semibold"
  • "bold"
  • "ultrabold"
  • "heavy"
stylesFontStyle[]

The font styles available for this specific font weight.

Available values:

  • "normal"
  • "italic"
previewUrlstring
Optional

The URL of an image that renders a preview of the font.