---
title: "Search and filter icons by specified order"
method: GET
path: "/v1/icons"
tags: ["Icons"]
---

# Search and filter icons by specified order

`GET /v1/icons`

## Request

- Base URL: `https://api.magnific.com`
- URL: `https://api.magnific.com/v1/icons`
- Auth: API key in header `x-magnific-api-key`

Get a list of icons based on the provided parameters and ordering criteria.

## Query parameters

- `term` string
- `slug` string
- `page` integer
- `per_page` integer
- `family-id` integer
- `order` 'relevance' | 'recent'
- `thumbnail_size` string
- `filters` SearchIconsFiltersParameter
  - `color` 'gradient' | 'solid-black' | 'multicolor' | 'azure' | 'black' | 'blue' | 'chartreuse' | 'cyan' | 'gray' | 'green' | 'orange' | 'red' | 'rose' | 'spring-green' | 'violet' | 'white' | 'yellow': Filter by color.
  - `shape` 'outline' | 'fill' | 'lineal-color' | 'hand-drawn': Filter by shape.
  - `period` 'three-months' | 'six-months' | 'one-year' | 'all': Filter by period.
  - `free_svg` 'all' | 'free' | 'premium': Filter by free svg, for free or premium item or all for both
  - `icon_type` string[]: Filter of available icon types.

## Headers

- `Accept-Language` string

## Response `200`

OK Response

- SearchIcons200Response
  - `data` IconB2b[]
    - `id` integer, required
    - `name` string, required
    - `created` string, date-time, required
    - `slug` string, required
    - `style` IconStyle, required
      - `id` integer, required: Style ID
      - `name` string, required: Style name
    - `family` IconFamily, nullable, required
      - `id` integer: Id of the icon family
      - `name` string: Name of the icon family
      - `total` integer: Total of icons in the family
    - `author` Author, required
      - `id` integer, required
      - `name` string, required
      - `avatar` string, uri, required
      - `assets` integer, required: The number of assets of this author.
      - `slug` string, required
    - `thumbnails` Source[], required
      - `url` string, uri
      - `width` integer
      - `height` integer
    - `free_svg` boolean, required: If true, the icon has the svg for free downloading
    - `tags` Tag[]
      - `slug` string
      - `name` string
  - `meta` SearchIcons200ResponseMeta
    - `pagination` Pagination, required: Metainformation about pagination
      - `current_page` integer: The current page.
      - `per_page` integer: The limit of resources per page.
      - `last_page` integer: The total number of pages.
      - `total` integer: The total number of resources.

## Other responses

- `400`: Bad Request - The server could not understand the request due to invalid syntax.
- `401`: Unauthorized - The client must authenticate itself to get the requested response.
- `404`: Not Found - The server can not find the requested resource.
- `500`: Internal Server Error - The server has encountered a situation it doesn't know how to handle.

---

[API](https://skmtc.dev/magnific/apis/magnific-api.md) · [All operations](https://skmtc.dev/magnific/apis/magnific-api/llms.txt) · [OpenAPI document](https://skmtc.dev/magnific/apis/magnific-api/revisions/60711fb082c7?raw)