kits/:kit/families/:family

This is documentation for Typekit’s original API. This API is still supported, but we encourage you to try the newer Typekit Platform API. If you have any questions, email us.

A font family used in a kit

Request methods

GET
Returns information about a font family used in a kit
POST
Add or update a font family in a kit, return updated information
DELETE
Remove a font family in a kit

Parameters

Path parameters:

:kit
The kit ID
:family
The ID of the font family

POST parameters:

subset
Character subset to use ("default" or "all"), defaults to "default" for new font families
variations
A list of font variations to use (formatted as a Font Variation Description), defaults to all available variations for new font families

When a POST parameter is included, it completely replaces the existing value with the new value.

Examples

Getting information about the use of droid-sans in a kit:

$ curl -s -H $tk_auth https://typekit.com/api/v1/json/kits/nfx3ygt/families/gkmg | jsonpretty
{
  "family": {
    "id": "gkmg",
    "name": "Droid Sans",
    "slug": "droid-sans",
    "css_names": [
      "droid-sans-1",
      "droid-sans-2"
    ],
    "css_stack": "\"droid-sans-1\",\"droid-sans-2\",sans-serif",
    "variations": [
      "n4"
    ],
    "subset": "default"
  }
}

Editing the subset of a font family already in a kit:

$ curl -s -H $tk_auth -F subset=default https://typekit.com/api/v1/json/kits/nfx3ygt/families/gkmg | jsonpretty
{
  "family": {
    "id": "gkmg",
    "name": "Droid Sans",
    "css_names": [
      "droid-sans-1",
      "droid-sans-2"
    ],
    "css_stack": "\"droid-sans-1\",\"droid-sans-2\",sans-serif",
    "variations": [
      "n4"
    ],
    "subset": "default"
  }
}

Adding all available variations of "Droid Sans Mono" with all characters to a kit:

$ curl -s -H $tk_auth -F subset=all https://typekit.com/api/v1/json/kits/nfx3ygt/families/vqgt | jsonpretty
{
  "family": {
    "id": "vqgt",
    "name": "Droid Sans Mono",
    "css_names": [
      "droid-sans-mono-1",
      "droid-sans-mono-2"
    ],
    "css_stack": "\"droid-sans-1\",\"droid-sans-2\",sans-serif",
    "variations": [
      "n4"
    ],
    "subset": "all"
  }
}

Removing "Droid Sans Mono" from a kit:

$ curl -s -H $tk_auth -X DELETE https://typekit.com/api/v1/json/kits/nfx3ygt/families/vqgt | jsonpretty
{
  "ok": true
}