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 "6.0.0". The word "latest" will resolve to the latest full version of 5.x but is deprecated for Version 6. |
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 "5.12.0". The word "latest" will resolve to the latest full version of 5.x but is deprecated for Version 6. |
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 Version 6.0.0.
search(version: "6.0.0", query: "coff", first: 5) { id }
{
"data": {
"search": [
{
"id": "coffin-cross"
},
{
"id": "coffin"
},
{
"id": "coffee-togo"
},
{
"id": "coffee-pot"
},
{
"id": "coffee"
}
]
}
}