Get Fonts

Learn how to retrieve custom fonts from your workspace

Published ·Updated

GET
/v1/brand-assets/fonts/get
curl -X GET "https://api.orshot.com/v1/brand-assets/fonts/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

Overview#

This endpoint allows you to retrieve a list of custom fonts uploaded to your workspace. Custom fonts can be used in your templates for consistent brand typography.

Endpoint
https://api.orshot.com/v1/brand-assets/fonts/get

Query Parameters#

ParameterTypeRequiredDescription
tagStringNoComma-separated list of tags to filter by. Returns only fonts that have all specified tags.
embedIdStringNoEmbed instance ID. Pair with embedUserId to scope this call to one embed user
embedUserIdStringNoThe same userId your app passes to the embed URL. Requires embedId

Request#

JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/fonts/get", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/fonts/get?tag=heading,brand", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JSON
{
  "data": [
    {
      "id": 456,
      "created_at": "2025-09-10T15:30:45.123Z",
      "font_family": "BrandFont Bold",
      "file_name": "BrandFont-Bold.ttf",
      "file_url": "https://storage.orshot.com/custom-fonts/workspace_id/BrandFont-Bold.ttf",
      "file_size": 184320,
      "file_type": "font/ttf",
      "tags": ["heading", "brand"],
      "workspace_id": 50,
      "user_id": "abcdef01-2345-6789-abcd-ef0123456789"
    }
  ]
}

Per-User Libraries#

Pass embedId and embedUserId together to return only that embed user's fonts instead of the whole workspace library. This is how one embed serves many brands or tenants, each with its own brand space.

Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.

Rate Limits#

  • 30 requests per minute per endpoint

Response Fields#

FieldTypeDescription
idNumberUnique identifier for the font
created_atStringTimestamp when the font was uploaded
font_familyStringFont family name — use this to reference the font in templates
file_nameStringOriginal font filename
file_urlStringURL to access the font file
file_sizeNumberFont file size in bytes
file_typeStringMIME type of the font file
tagsString[]Tags associated with the font
workspace_idNumberID of the workspace the font belongs to
user_idStringID of the user who uploaded the font
Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 50+ integrations
  • White-label embed for your own app
  • 100 free credits a month, no credit card required