Query Fields

These are the top-level query fields in the schema.

me (Account)

The account identified by the access token used in the Authorization header.

release (Release)

Metadata for the release specified by the version argument.

Argument	Type	Description
version	String!	required. Must be a major.minor.patch version number like “7.0.0” or major.”x” like “7.x”. The word “latest” will resolve to the latest full version of 5.x but is deprecated for v6.

releases ([Release])

List of all available releases.

search ([Icon])

Results for an icon query, using the same Algolia search engine that powers the Icon Gallery.

If this field resolves as null, it means there was a problem executing the search, such as attempting to search on a non-existent version of Font Awesome. The errors returned may include additional information.

Argument	Type	Description
version	String!	required. Must be a major.minor.patch version number like “7.0.1” or major.”x” like “7.x”. The word “latest” will resolve to the latest full version of 7.x but is deprecated for v6 and above.
query	String!	required. A string of search terms, like “coff” or “coffee mug”
first	Integer	default: 15. Limit results to this number: the first “X” results.

Example:

This will return the first five results matching the query “coff” for v7.0.0.

search(version: "7.0.0", query: "coff", first: 5) { id }

{
  "data": {
    "search": [
      {
        "id": "coffin-cross"
      },
      {
        "id": "coffin"
      },
      {
        "id": "coffee-togo"
      },
      {
        "id": "coffee-pot"
      },
      {
        "id": "coffee"
      }
    ]
  }
}

Fuzzy Search vs. Finding an Icon by Name

The search field is intended for fuzzy searching. It does a lot more than just match search terms against the names of icons. That’s great for helping users to discover icons according to concepts or word associations. It also helps if you can’t remember the exact name of an icon: close enough is probably good enough!

When searching “coffee”, for example, it may help you discover that there are coffee-related icons beyond that familiar mug-saucer icon—which, by the way, is no longer called “coffee”! A search for “coffee” also finds coffee beans, coffee pots, to-go coffee cups, and more.

However, if you want to look up a specific icon by name, there’s no guarantee that it’ll turn up as the first search result, even if you search by its exact name. So if you’re looking to select a specific icon by name, use the icon field under a release instead of search.

getKitDownload (KitDownload!)

Poll for the status of kit download request.

After a kit download request is started with the createKitDownload mutation, use this query field with the returned buildId to poll for the status of the kit download request until it is READY and the short-lived url for downloading the kit zip archive is available.

While the kit download request is still being processed, the returned KitDownload object will have a status of PENDING. The client should continue polling with this query field until the status changes to READY.

The client should poll no more than once per second to avoid being rate-limited.

Required authorization scope: kits_download

Argument	Type	Description
buildId	String!	required. A buildId from a KitDownload object produced by a prior invocation of the createKitDownload mutation.
kitToken	String!	required. The kit token for the kit download request being polled.
buildType	BuildType!	required. The type of kit download request being polled.