Get an iconographic symbol by name

Attempts to retrieve an iconographic symbol by its name from the Noun Project API.

This endpoint supports both JSON and PNG responses.

If the icon is not found and a PNG response is requested, it will return a fallback icon in form of a magnifying glass.

GET /v2/assets/icons/{iconName}

Get an iconographic symbol by name

cURL

curl --request GET \
  --url https://rest.forestreet.com/v2/assets/icons/{iconName} \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "data": "<string>"
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

x-api-key · string · header · required

Pass a static API key for every request, provided by your customer support.

Path Parameters

iconName · string · required

Name of the icon to retrieve.

Required string length: 1 - 100

Query Parameters

fallbackTo · string

Fallback icon name to use if the requested icon is not found.

Required string length: 1 - 100

contentType · enum<string> · default: image/png

Content type for the image endpoint. Defaults to 'image/png'. Use 'application/json' to get base64 encoded image.

Available options: image/png, application/json

Response

200

application/json

Iconographic symbol by name response

success · boolean · required

Indicates if the asset was successfully retrieved.

data · string · required

Base64 encoded asset data.