An icon set's samples

GET

/api/v1/icons/{prefix}/samples

curl --request GET \
  --url http://localhost:3000/api/v1/icons/example/samples \
  --header 'Authorization: Bearer <token>'

The few icons a set is shown by (its samples), each drawn as the SVG an import would store.

Scope: read.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

prefix

required

string

The set, as Iconify names it: tabler, lucide, simple-icons

Responses

200

The set’s samples

Media typeapplication/json

object

data

required

The set’s samples, those it has

Array<object>

object

name

required

string

svg

required

The file an import stores

string

Example^generated

{
  "data": [
    {
      "name": "example",
      "svg": "example"
    }
  ]
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}