GET
/
v1
/
icons
{
  "data": [
    {
      "free_svg": true,
      "created": "2023-03-07T23:05:26.000Z",
      "author": {
        "assets": 0,
        "name": "John Doe",
        "id": 2147483647,
        "avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
        "slug": "merry-christmas"
      },
      "name": "a woman reads a book in a tablet sits in the luxurious back of the library",
      "id": 52912,
      "family": {
        "total": 1200,
        "name": "Outline",
        "id": 1
      },
      "thumbnails": [
        {
          "width": 512,
          "url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
          "height": 512
        },
        {
          "width": 512,
          "url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
          "height": 512
        }
      ],
      "slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
    },
    {
      "free_svg": true,
      "created": "2023-03-07T23:05:26.000Z",
      "author": {
        "assets": 0,
        "name": "John Doe",
        "id": 2147483647,
        "avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
        "slug": "merry-christmas"
      },
      "name": "a woman reads a book in a tablet sits in the luxurious back of the library",
      "id": 52912,
      "family": {
        "total": 1200,
        "name": "Outline",
        "id": 1
      },
      "thumbnails": [
        {
          "width": 512,
          "url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
          "height": 512
        },
        {
          "width": 512,
          "url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
          "height": 512
        }
      ],
      "slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

x-freepik-api-key
string
headerrequired

Your Freepik API key. Required for authentication. Learn how to obtain an API key

Headers

Accept-Language
string

Specifies the search query language using the ISO 639-1 (2-letter language code) and the ISO 3166-1 (2-letter country code) for language variants. The API will use "en-US" as a default language for processing if a code is not provided, or does not exist.

Query Parameters

term
string

Search term. If only term comes, it is searched for term, if only slug comes, it is searched for slug and if both come, it is searched for slug

slug
string

Search by slug

page
integer

Page number. It must be greater than 0.

per_page
integer

Results per page. It must be greater than 0.

family-id
integer

Icon family id.

Required range: x > 1
order
enum<string>
default: relevance

Define order of results.

  • Note: If the term or slug parameter is used, the order will be the similarity of the search.
Available options:
relevance,
recent
filters[color]
enum<string>

Filter by color.

Available options:
gradient,
solid-black,
multicolor,
azure,
black,
blue,
chartreuse,
cyan,
gray,
green,
orange,
red,
rose,
spring-green,
violet,
white,
yellow
filters[shape]
enum<string>

Filter by shape.

Available options:
outline,
fill,
lineal-color,
hand-drawn
filters[period]
enum<string>

Filter by period.

Available options:
three-months,
six-months,
one-year,
all
filters[free_svg]
enum<string>

Filter by free svg, for free or premium item or all for both

Available options:
all,
free,
premium
thumbnail_size
string

Size of the thumbnail. If the size is not specified, the API will return 128 as a default size.

Response

200 - application/json
data
object[]
meta
object

Was this page helpful?

Get the detail of a resource (psd, vector or photo)Retrieve one icon by its unique ID