NAV Navbar
JavaScript
  • Flaticon API v2
  • Authentication
  • Get Access Token
  • Totals
  • Styles
  • Tags
  • Items
  • Categories
  • Search
  • Schemas
  • Flaticon API v2

    Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

    Simple reference for Flaticon API. The entrypoint of the API is https://profile.flaticon.com/request/api/

    Base URLs:

    Email: Flaticon API support Web: Flaticon API support

    Authentication

    Get Access Token

    BearerToken

    Code samples

    var headers = {
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/app/authentication',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    POST /app/authentication

    It returns a valid token for making requests to the API.

    Through a “post” request, it will be possible to authenticate your credentials (private API key) in the Flaticon API. As an answer to the request, you’ll receive a temporal authentication token which you can use to make other requests. The authentication token will expiry in an hour. After that, you’ll need to request that token again in order to continue working with the API. If you want to use the Flaticon API, you can contact us at info@flaticon.com and request a personal API key. For more info, contact us at info@flaticon.com or check our FAQ at https://support.flaticon.com/

    Body parameter

    apikey: string
    
    
    

    Parameters

    Parameter In Type Required Description
    body body object false No description
    » apikey body string false Private API key assigned to an API user.

    Detailed descriptions

    » apikey: Private API key assigned to an API user. For example: 720ed16a5b36858asd2589d883bdea6d4587280e953

    Example responses

    {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiI0ZDEzOGViMi1hMDE5LTRhYzEtYWJmNy0wYTMxMDYyZTQ2NzgiLCJleHAiOjE1MDg4NDM3MjIsImlkIjoiNDQ2OTE4NCJ9.FlexrpEdISo-Pfpx5dS3znUVPU229p6SlncT2AJZzN8",
      "expires": 1508399774
    }
    
    {
      "error": "The requested resource couldn’t be obtained."
    }
    
    {
      "error": "An API key is needed to log in. Please try again with a valid API key."
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. LoginResponse
    501 Not Implemented The request is not correct. ErrorResponse
    503 Service Unavailable A valid API key is needed to request an authentication token. ApiKeyNotValid

    Totals

    totalIcons

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/total/icons',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /total/icons

    It gives you a numeric value stating the full quantity of icons available at Flaticon.

    Method that allows you to get a number stating the full quantity of icons available at Flaticon. The number refreshes periodically according to the content available at flaticon.com.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "total": 100
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TotalResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    totalIconsPremium

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/total/icons/premium',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /total/icons/premium

    It gives you a numeric value stating the full quantity of PREMIUM icons available at Flaticon.

    Method that allows you to get a number stating the full quantity of PREMIUM icons available at Flaticon. The number refreshes periodically according to the content available at flaticon.com.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "total": 100
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TotalResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    totalIconsSelection

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/total/icons/selection',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /total/icons/selection

    It gives you a numeric value stating the full quantity of SELECTION icons available at Flaticon.

    Method that allows you to get a number stating the full quantity of SELECTION icons available at Flaticon. The number refreshes periodically according to the content available at flaticon.com.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "total": 100
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TotalResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    totalPacks

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/total/packs',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /total/packs

    It gives you a numeric value stating the full quantity of packs available at Flaticon.

    Method that allows you to get a number stating the full quantity of packs available at Flaticon. The number refreshes periodically according to the content available at flaticon.com. Packs are sorted into two groups: PREMIUM packs and SELECTION packs. PREMIUM packs are those that contain one or more PREMIUM icons.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "total": 100
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TotalResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    totalPacksPremium

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/total/packs/premium',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /total/packs/premium

    It gives you a numeric value stating the full quantity of PREMIUM packs available at Flaticon.

    Method that allows you to get a number stating the full quantity of PREMIUM packs available at Flaticon. The number refreshes periodically according to the content available at flaticon.com. PREMIUM packs are those that contain one or more PREMIUM icons.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "total": 100
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TotalResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    totalPacksSelection

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/total/packs/selection',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /total/packs/selection

    It gives you a numeric value stating the full quantity of SELECTION packs available at Flaticon.

    Method that allows you to get a number stating the full quantity of SELECTION packs available at Flaticon. The number refreshes periodically according to the content available at flaticon.com. SELECTION packs are those that contain only SELECTION icons.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "total": 100
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TotalResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    Styles

    styles

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/styles',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /styles

    It gives you a list with all Flaticon styles.

    Method that allows you to get a paged list with information about Flaticon styles, design formats that icons or packs have. Styles are the different versions in which an icon from a given family may appear. For example, an icon may be available in lineal, color, or lineal color styles.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    page query integer false Page about which the request is made. In case it doesn’t exist, it will return page 1.
    limit query integer false Number of max. authors returned per request. In case it isn’t requested, it will return 100 styles by default.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": [
        {
          "id": "50",
          "family_id": "17",
          "icons": null,
          "packs": null,
          "class": "flat",
          "name": "Yellow shadow",
          "description": "Eucalypt",
          "slug": "family/meticulous/yellow-shadow",
          "family_icons": null,
          "family_packs": null,
          "family_name": "Meticulous",
          "family_description": null,
          "family_slug": "family/meticulous",
          "x-widdershins-oldRef": "#/components/schemas/Style/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. StylesResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    style

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/style/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /style/{id}

    It gives you detailed information about a style.

    Method that allows you go get detailed information about a style, the design format that an icon or a pack has. Styles are the different versions in which an icon a given family may appear. For example, an icon may be available in lineal, color, or lineal color styles.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    id path integer true No description

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "id": "50",
        "family_id": "17",
        "icons": null,
        "packs": null,
        "class": "flat",
        "name": "Yellow shadow",
        "description": "Eucalypt",
        "slug": "family/meticulous/yellow-shadow",
        "family_icons": null,
        "family_packs": null,
        "family_name": "Meticulous",
        "family_description": null,
        "family_slug": "family/meticulous",
        "x-widdershins-oldRef": "#/components/schemas/Style/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. StyleResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    Tags

    tags

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/tags',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /tags

    It gives you a list with all Flaticon tags.

    Method that allows you to get a paged list with information about Flaticon tags that icons or packs have.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    page query integer false Page about which the request is made. In case it doesn’t exist, it will return page 1.
    limit query integer false Number of max. authors returned per request. In case it isn’t requested, it will return 100 styles by default.
    havingStickers query integer false Get tags that have stickers

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": [
        {
          "id": 203989,
          "tag": "abc block",
          "slug": "free-icons/abc-block",
          "stickers": 0,
          "x-widdershins-oldRef": "#/components/schemas/Tag/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TagsResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    tag

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/tag/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /tag/{id}

    It gives you detailed information about a tag.

    Method that allows you go get detailed information about a tag.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    id path integer true No description

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "id": 203989,
        "tag": "abc block",
        "slug": "free-icons/abc-block",
        "stickers": 0,
        "x-widdershins-oldRef": "#/components/schemas/Tag/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. TagResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    Items

    icons

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/items/icons/{orderBy}',
      method: 'get',
      data: '?q=string',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /items/icons/{orderBy}

    It gives you a list with the icons available at Flaticon.

    Method that allows you to get a paged list with information about the icons available at Flaticon. By default, it will return a list order by priority. If no order is set, it will return items order by priority. In order to avoid 403 errors when svg icon is used to show the icon in result lists you must not store data in cache more than 15 minutes. SVG icons will only be available for premium API users

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    orderBy URI string false Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon.
    page query integer false Page number
    q query string true term to search for
    url query string false icon url to search for
    designerId query integer false Filter the results by designer id.
    styleId query integer false Filter the results by style id.
    categoryId query integer false Filter the results by category id.
    familyId query integer false Filter the results by family id.
    packId query integer false Filter the results by pack id.
    designerName query string false Filter the results by designer name.
    styleName query string false Filter the results by the name of style.
    categoryName query string false Filter the results by category name.
    familyName query string false Filter the results by family name.
    tagsId query string false Filter the results by a list of tag ids separated by comma
    stroke query integer false Filter the results by stroke id. Stroke id 1 means filled. Stroke id 2 means linear.
    color query integer false Filter the results by color id. Color id 1 means monocolor. Color id 2 means multicolor.
    iconType query string false Filter the results by icon type, valid values are standard and stickers
    limit query integer false Number of max. items returned per request. In case it isn’t requested, it will return 100 packs by default.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    orderBy: Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon. For example: https://api.flaticon.com/v2/search/icons/added?q=arrow&stroke=2&styleName=gradient&packId=1554346&limit=15

    Example responses

    {
      "data": [
        {
          "id": 639788,
          "type": "4",
          "priority": "150.000000",
          "selection": 1,
          "premium": 1,
          "state": 1,
          "description": "Net",
          "colors": "",
          "color": 1,
          "style": 0,
          "stroke": 2,
          "detail": 0,
          "style_id": 132,
          "style_name": "",
          "style_slug": "",
          "style_class": "",
          "family_id": 0,
          "family_name": "",
          "family_slug": "",
          "priority_style": "0.000000",
          "slug": "free-icon/net_639788",
          "license": "2",
          "added": 1511878441,
          "pack_id": 639744,
          "pack_name": "Sport",
          "pack_slug": "packs/sport-21",
          "pack_background": "clouds",
          "pack_priority": "150.000000",
          "pack_items": 100,
          "group_id": 229,
          "team_id": 296,
          "group_slug": "made-by-made-premium",
          "team_name": "Made by Made Premium",
          "team_website": "",
          "downloads": "0",
          "views": "0",
          "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
          "category": "sports",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "414,489,505,782,30348,198081,198499",
          "category_id": "9,74",
          "images": {
            "png": {
              "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
              "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
            },
            "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
          },
          "x-widdershins-oldRef": "#/components/schemas/Icon/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. IconsResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    icon

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/item/icon/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /item/icon/{id}

    It gives you detailed information about an icon. SVG url will only be available for premium API users

    Method that allows you to get detailed information about an icon.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    id path integer true No description

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "id": 639788,
        "type": "4",
        "priority": "150.000000",
        "selection": 1,
        "premium": 1,
        "state": 1,
        "description": "Net",
        "colors": "",
        "color": 1,
        "style": 0,
        "stroke": 2,
        "detail": 0,
        "style_id": 132,
        "style_name": "",
        "style_slug": "",
        "style_class": "",
        "family_id": 0,
        "family_name": "",
        "family_slug": "",
        "priority_style": "0.000000",
        "slug": "free-icon/net_639788",
        "license": "2",
        "added": 1511878441,
        "pack_id": 639744,
        "pack_name": "Sport",
        "pack_slug": "packs/sport-21",
        "pack_background": "clouds",
        "pack_priority": "150.000000",
        "pack_items": 100,
        "group_id": 229,
        "team_id": 296,
        "group_slug": "made-by-made-premium",
        "team_name": "Made by Made Premium",
        "team_website": "",
        "downloads": "0",
        "views": "0",
        "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
        "category": "sports",
        "item_equivalent": "0",
        "equivalents": 0,
        "tags_id": "414,489,505,782,30348,198081,198499",
        "category_id": "9,74",
        "images": {
          "png": {
            "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
            "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
          },
          "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
        },
        "x-widdershins-oldRef": "#/components/schemas/Icon/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. IconResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    packs

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/items/packs/{orderBy}',
      method: 'get',
      data: '?q=string',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /items/packs/{orderBy}

    It gives you a list with the packs available at Flaticon.

    Method that allows you to get a paged list with information about the packs available at Flaticon. A pack is a set of icons that share a theme. Besides, any given pack may be found in one or many styles associated or not with a family. By default, it will return a list order by priority. If no order is set, it will return items order by priority.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    orderBy URI string false Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon.
    page query integer false Page number
    q query string true term to search for
    url query string false icon url to search for
    designerId query integer false Filter the results by designer id.
    styleId query integer false Filter the results by style id.
    categoryId query integer false Filter the results by category id.
    familyId query integer false Filter the results by family id.
    packId query integer false Filter the results by pack id.
    designerName query string false Filter the results by designer name.
    styleName query string false Filter the results by the name of style.
    categoryName query string false Filter the results by category name.
    familyName query string false Filter the results by family name.
    tagsId query string false Filter the results by a list of tag ids separated by comma
    stroke query integer false Filter the results by stroke id. Stroke id 1 means filled. Stroke id 2 means linear.
    color query integer false Filter the results by color id. Color id 1 means monocolor. Color id 2 means multicolor.
    iconType query string false Filter the results by icon type, valid values are standard and stickers
    limit query integer false Number of max. items returned per request. In case it isn’t requested, it will return 100 packs by default.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    orderBy: Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon. For example: https://api.flaticon.com/v2/search/icons/added?q=arrow&stroke=2&styleName=gradient&packId=1554346&limit=15

    Example responses

    {
      "data": [
        {
          "id": 150173,
          "type": "5",
          "priority": "175.033997",
          "selection": 1,
          "premium": 0,
          "state": 1,
          "description": "Team Organization Human  Pictograms",
          "colors": "peter-river",
          "color": 1,
          "style": 3,
          "stroke": 2,
          "detail": 2,
          "style_id": 10,
          "style_name": "Fill",
          "style_slug": "family/pictograms/filled",
          "style_class": "filled",
          "family_id": 5,
          "family_name": "Pictograms",
          "family_slug": "family/pictograms",
          "priority_style": "0.000000",
          "slug": "packs/team-organization-human-pictograms",
          "license": "2",
          "added": 1463669759,
          "pack_id": 0,
          "pack_name": "",
          "pack_slug": "",
          "pack_background": "",
          "pack_priority": "0.000000",
          "pack_items": 30,
          "group_id": 1,
          "team_id": 166,
          "group_slug": "freepik",
          "team_name": "Freepik",
          "team_website": "http://www.freepik.com",
          "downloads": "0",
          "views": "0",
          "tags": "people,business,manager,businessman,worker,stick man,humanpictos",
          "category": "people",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "112,243,21266,21515,22204,180597,189708",
          "category_id": "30,33",
          "images": {
            "sprite": "https://image.flaticon.com/sprites/new_packs/150173-team-organization-human-pictograms.png"
          },
          "x-widdershins-oldRef": "#/components/schemas/Pack/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. PacksResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    pack

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/item/pack/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /item/pack/{id}

    It gives you detailed information about a pack.

    Method that allows you to get detailed information about a pack. A pack is a set of icons that share a theme. Besides, any given pack may be found in one or many styles associated or not with a family.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    id path integer true No description

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "id": 150173,
        "type": "5",
        "priority": "175.033997",
        "selection": 1,
        "premium": 0,
        "state": 1,
        "description": "Team Organization Human  Pictograms",
        "colors": "peter-river",
        "color": 1,
        "style": 3,
        "stroke": 2,
        "detail": 2,
        "style_id": 10,
        "style_name": "Fill",
        "style_slug": "family/pictograms/filled",
        "style_class": "filled",
        "family_id": 5,
        "family_name": "Pictograms",
        "family_slug": "family/pictograms",
        "priority_style": "0.000000",
        "slug": "packs/team-organization-human-pictograms",
        "license": "2",
        "added": 1463669759,
        "pack_id": 0,
        "pack_name": "",
        "pack_slug": "",
        "pack_background": "",
        "pack_priority": "0.000000",
        "pack_items": 30,
        "group_id": 1,
        "team_id": 166,
        "group_slug": "freepik",
        "team_name": "Freepik",
        "team_website": "http://www.freepik.com",
        "downloads": "0",
        "views": "0",
        "tags": "people,business,manager,businessman,worker,stick man,humanpictos",
        "category": "people",
        "item_equivalent": "0",
        "equivalents": 0,
        "tags_id": "112,243,21266,21515,22204,180597,189708",
        "category_id": "30,33",
        "images": {
          "sprite": "https://image.flaticon.com/sprites/new_packs/150173-team-organization-human-pictograms.png"
        },
        "x-widdershins-oldRef": "#/components/schemas/Pack/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. PackResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    download

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/item/icon/download/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /item/icon/download/{id}

    It downloads the item

    Method that allows you to download the selected icon with the selected format.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    id path integer true No description
    format path string true Item format to download. Is possible to choose between 'svg' and 'png' formats. If no format is sent, it will return the item in 'png' format. Downloads in SVG format will only be available for premium API users
    color query string false Monocolor Icons can be downloaded in different colors. Color property has to be a valid hexadecimal color. If no color is sent, it will return the icon in black.
    size query string false Size to download the selected Icon. the valid sizes are: 16, 24, 32, 64, 128, 256, 512. If no size is sent it will return the icon with a size of 32px

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    format: Item format to download. Is possible to choose between 'svg' and 'png' formats. If no format is sent, it will return the item in 'png' format. Downloads in SVG format will only be available for premium API users

    color: Monocolor Icons can be downloaded in different colors. Color property has to be a valid hexadecimal color. If no color is sent, it will return the icon in black.

    size: Size to download the selected Icon. the valid sizes are: 16, 24, 32, 64, 128, 256, 512. If no size is sent it will return the icon with a size of 32px

    Example responses

    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. Inline
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    Categories

    categories

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/categories',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /categories

    It gives you a list with all Flaticon categories.

    Method that allows you to get a paged list with information about Flaticon categories. Categories are the different themes in which icons are grouped at Flaticon.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    page query integer false Page about which the request is made. In case it doesn’t exist, it will return page 1.
    limit query integer false Number of max. authors returned per request. In case it isn’t requested, it will return 100 categories by default.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": [
        {
          "id": 11,
          "icons": "53",
          "name": "Animals",
          "url": "https://www.flaticon.com/categories/animals",
          "api_resources": {
            "category": "http://localhost:8080/v2/category/11"
          },
          "sprites": {
            "general": "https://image.flaticon.com/sprites/categories/11.png",
            "small": "https://image.flaticon.com/sprites/extension/categories/11.png",
            "share": "https://image.flaticon.com/sprites/share/categories/animals.png"
          },
          "x-widdershins-oldRef": "#/components/schemas/Category/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. CategoriesResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    category

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/category/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /category/{id}

    It gives you detailed information about a category.

    Method that allows you to get detailed information about a category. Categories are the different themes in which icons are grouped at Flaticon.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    id path integer true No description

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    Example responses

    {
      "data": {
        "id": 11,
        "icons": "53",
        "name": "Animals",
        "url": "https://www.flaticon.com/categories/animals",
        "api_resources": {
          "category": "http://localhost:8080/v2/category/11"
        },
        "sprites": {
          "general": "https://image.flaticon.com/sprites/categories/11.png",
          "small": "https://image.flaticon.com/sprites/extension/categories/11.png",
          "share": "https://image.flaticon.com/sprites/share/categories/animals.png"
        },
        "x-widdershins-oldRef": "#/components/schemas/Category/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. CategoryResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    Search

    searchIcons

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/search/icons/{orderBy}',
      method: 'get',
      data: '?q=string',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /search/icons/{orderBy}

    It returns a list with all the icons according to the search.

    Method that allows you to get a paged list with the results of the search. Icons returned by the search may be SELECTION icons or PREMIUM icons. By default, it will return a list order by priority. If no order is set, it will return items order by priority. In order to avoid 403 errors when svg icon is used to show the icon in result lists you must not store data in cache more than 15 minutes. SVG icons will only be available for premium API users

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    orderBy URI string false Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon.
    page query integer false Page number
    q query string true term to search for
    url query string false icon url to search for
    designerId query integer false Filter the results by designer id.
    styleId query integer false Filter the results by style id.
    categoryId query integer false Filter the results by category id.
    familyId query integer false Filter the results by family id.
    packId query integer false Filter the results by pack id.
    designerName query string false Filter the results by designer name.
    styleName query string false Filter the results by the name of style.
    categoryName query string false Filter the results by category name.
    familyName query string false Filter the results by family name.
    tagsId query string false Filter the results by a list of tag ids separated by comma
    stroke query integer false Filter the results by stroke id. Stroke id 1 means filled. Stroke id 2 means linear.
    color query integer false Filter the results by color id. Color id 1 means monocolor. Color id 2 means multicolor.
    iconType query string false Filter the results by icon type, valid values are standard and stickers
    limit query integer false Number of max. items returned per request. In case it isn’t requested, it will return 100 packs by default.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    orderBy: Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon. For example: https://api.flaticon.com/v2/search/icons/added?q=arrow&stroke=2&styleName=gradient&packId=1554346&limit=15

    Example responses

    {
      "data": [
        {
          "id": 639788,
          "type": "4",
          "priority": "150.000000",
          "selection": 1,
          "premium": 1,
          "state": 1,
          "description": "Net",
          "colors": "",
          "color": 1,
          "style": 0,
          "stroke": 2,
          "detail": 0,
          "style_id": 132,
          "style_name": "",
          "style_slug": "",
          "style_class": "",
          "family_id": 0,
          "family_name": "",
          "family_slug": "",
          "priority_style": "0.000000",
          "slug": "free-icon/net_639788",
          "license": "2",
          "added": 1511878441,
          "pack_id": 639744,
          "pack_name": "Sport",
          "pack_slug": "packs/sport-21",
          "pack_background": "clouds",
          "pack_priority": "150.000000",
          "pack_items": 100,
          "group_id": 229,
          "team_id": 296,
          "group_slug": "made-by-made-premium",
          "team_name": "Made by Made Premium",
          "team_website": "",
          "downloads": "0",
          "views": "0",
          "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
          "category": "sports",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "414,489,505,782,30348,198081,198499",
          "category_id": "9,74",
          "images": {
            "png": {
              "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
              "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
            },
            "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
          },
          "x-widdershins-oldRef": "#/components/schemas/Icon/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. IconsResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    searchPacks

    Code samples

    var headers = {
      'Accept':'application/json',
      'Authorization':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.flaticon.com/v2/search/packs',
      method: 'get',
      data: '?q=string',
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    

    GET /search/packs

    It returns a list with all the icons according to the search

    Method that allows you to get a paged list with the results of the search. Packs returned by the search may be SELECTION packs or PREMIUM packs, according to the content.

    Parameters

    Parameter In Type Required Description
    Authorization header string true A temporal authentication token is needed to validate the request.
    orderBy URI string false Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon.
    page query integer false Page number
    q query string true term to search for
    url query string false pack url to search for
    designerId query integer false Filter the results by designer id.
    styleId query integer false Filter the results by style id.
    categoryId query integer false Filter the results by category id.
    familyId query integer false Filter the results by family id.
    packId query integer false Filter the results by pack id.
    designerName query string false Filter the results by designer name.
    styleName query string false Filter the results by the name of style.
    categoryName query string false Filter the results by category name.
    familyName query string false Filter the results by family name.
    tagsId query string false Filter the results by a list of tag ids separated by comma
    stroke query integer false Filter the results by stroke id. Stroke id 1 means filled. Stroke id 2 means linear.
    color query integer false Filter the results by color id. Color id 1 means monocolor. Color id 2 means multicolor.
    iconType query string false Filter the results by icon type, valid values are standard and stickers
    limit query integer false Number of max. items returned per request. In case it isn’t requested, it will return 100 packs by default.

    Detailed descriptions

    Authorization: A temporal authentication token is needed to validate the request. For example: Bearer ASApqasdfFjrqjwnwqerqw-q.erqwecrqjewr9qwer0qwe8rq7er...

    orderBy: Order by in results from Flaticon API. You can choose between order the results between 'priority' or 'added'. Priority order will return items ordered by an algorithm based on the downloads ratio. Added order will return items ordered by the date they were added to Flaticon. For example: https://api.flaticon.com/v2/search/packs/added?q=media&stroke=2&styleName=gradient&packId=1554346&limit=15

    Example responses

    {
      "data": [
        {
          "id": 150173,
          "type": "5",
          "priority": "175.033997",
          "selection": 1,
          "premium": 0,
          "state": 1,
          "description": "Team Organization Human  Pictograms",
          "colors": "peter-river",
          "color": 1,
          "style": 3,
          "stroke": 2,
          "detail": 2,
          "style_id": 10,
          "style_name": "Fill",
          "style_slug": "family/pictograms/filled",
          "style_class": "filled",
          "family_id": 5,
          "family_name": "Pictograms",
          "family_slug": "family/pictograms",
          "priority_style": "0.000000",
          "slug": "packs/team-organization-human-pictograms",
          "license": "2",
          "added": 1463669759,
          "pack_id": 0,
          "pack_name": "",
          "pack_slug": "",
          "pack_background": "",
          "pack_priority": "0.000000",
          "pack_items": 30,
          "group_id": 1,
          "team_id": 166,
          "group_slug": "freepik",
          "team_name": "Freepik",
          "team_website": "http://www.freepik.com",
          "downloads": "0",
          "views": "0",
          "tags": "people,business,manager,businessman,worker,stick man,humanpictos",
          "category": "people",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "112,243,21266,21515,22204,180597,189708",
          "category_id": "30,33",
          "images": {
            "sprite": "https://image.flaticon.com/sprites/new_packs/150173-team-organization-human-pictograms.png"
          },
          "x-widdershins-oldRef": "#/components/schemas/Pack/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    
    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The request has been successfully made. PacksResponse
    401 Unauthorized Authentication token expired or non-existent. ExpiredToken

    Schemas

    LoginResponse

    {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiI0ZDEzOGViMi1hMDE5LTRhYzEtYWJmNy0wYTMxMDYyZTQ2NzgiLCJleHAiOjE1MDg4NDM3MjIsImlkIjoiNDQ2OTE4NCJ9.FlexrpEdISo-Pfpx5dS3znUVPU229p6SlncT2AJZzN8",
      "expires": 1508399774
    }
    

    Properties

    Name Type Required Description
    token string false Your temporal authentication token.
    expires integer false Expiry date of the token (in timestamp format).

    ExpiredToken

    {
      "status": "error",
      "message": "Expired token | Token not found"
    }
    

    Properties

    Name Type Required Description
    status string false No description
    message string false No description

    TotalResponse

    {
      "data": {
        "total": 100
      }
    }
    

    Properties

    Name Type Required Description
    data object false No description
    » total integer false Number of elements.

    ErrorResponse

    {
      "error": "The requested resource couldn’t be obtained."
    }
    

    Properties

    Name Type Required Description
    error string false Error type description

    ApiKeyNotValid

    {
      "error": "An API key is needed to log in. Please try again with a valid API key."
    }
    

    Properties

    Name Type Required Description
    error string false A valid API key is needed to make this request.

    Metadata

    {
      "page": 1,
      "count": 7,
      "total": 7,
      "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
    }
    

    Properties

    Name Type Required Description
    page integer false No description
    count integer false No description
    total integer false No description

    StylesResponse

    {
      "data": [
        {
          "id": "50",
          "family_id": "17",
          "icons": null,
          "packs": null,
          "class": "flat",
          "name": "Yellow shadow",
          "description": "Eucalypt",
          "slug": "family/meticulous/yellow-shadow",
          "family_icons": null,
          "family_packs": null,
          "family_name": "Meticulous",
          "family_description": null,
          "family_slug": "family/meticulous",
          "x-widdershins-oldRef": "#/components/schemas/Style/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    

    Properties

    Name Type Required Description
    data [Style] false No description
    metadata Metadata false No description

    StyleResponse

    {
      "data": {
        "id": "50",
        "family_id": "17",
        "icons": null,
        "packs": null,
        "class": "flat",
        "name": "Yellow shadow",
        "description": "Eucalypt",
        "slug": "family/meticulous/yellow-shadow",
        "family_icons": null,
        "family_packs": null,
        "family_name": "Meticulous",
        "family_description": null,
        "family_slug": "family/meticulous",
        "x-widdershins-oldRef": "#/components/schemas/Style/example"
      }
    }
    

    Properties

    Name Type Required Description
    data Style false No description

    TagsResponse

    {
      "data": [
        {
          "id": 203989,
          "tag": "abc block",
          "slug": "free-icons/abc-block",
          "stickers": 0,
          "x-widdershins-oldRef": "#/components/schemas/Tag/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    

    Properties

    Name Type Required Description
    data [Tag] false No description
    metadata Metadata false No description

    TagResponse

    {
      "data": {
        "id": 203989,
        "tag": "abc block",
        "slug": "free-icons/abc-block",
        "stickers": 0,
        "x-widdershins-oldRef": "#/components/schemas/Tag/example"
      }
    }
    

    Properties

    Name Type Required Description
    data Tag false No description

    Style

    {
      "id": "50",
      "family_id": "17",
      "icons": null,
      "packs": null,
      "class": "flat",
      "name": "Yellow shadow",
      "description": "Eucalypt",
      "slug": "family/meticulous/yellow-shadow",
      "family_icons": null,
      "family_packs": null,
      "family_name": "Meticulous",
      "family_description": null,
      "family_slug": "family/meticulous",
      "x-widdershins-oldRef": "#/components/schemas/Style/example"
    }
    

    Properties

    Name Type Required Description
    id string false No description
    family_id string false No description
    icons string false No description
    packs string false No description
    class string false No description
    name string false No description
    description string false No description
    slug string false No description
    family_icons string false No description
    family_packs string false No description
    family_name string false No description
    family_description string false No description
    family_slug string false No description

    Tag

    {
      "id": 203989,
      "tag": "abc block",
      "slug": "free-icons/abc-block",
      "stickers": 0,
      "x-widdershins-oldRef": "#/components/schemas/Tag/example"
    }
    

    Properties

    Name Type Required Description
    id integer false No description
    tag string false No description
    slug string false No description
    stickers integer false No description

    IconsResponse

    {
      "data": [
        {
          "id": 639788,
          "type": "4",
          "priority": "150.000000",
          "selection": 1,
          "premium": 1,
          "state": 1,
          "description": "Net",
          "colors": "",
          "color": 1,
          "style": 0,
          "stroke": 2,
          "detail": 0,
          "style_id": 132,
          "style_name": "",
          "style_slug": "",
          "style_class": "",
          "family_id": 0,
          "family_name": "",
          "family_slug": "",
          "priority_style": "0.000000",
          "slug": "free-icon/net_639788",
          "license": "2",
          "added": 1511878441,
          "pack_id": 639744,
          "pack_name": "Sport",
          "pack_slug": "packs/sport-21",
          "pack_background": "clouds",
          "pack_priority": "150.000000",
          "pack_items": 100,
          "group_id": 229,
          "team_id": 296,
          "group_slug": "made-by-made-premium",
          "team_name": "Made by Made Premium",
          "team_website": "",
          "downloads": "0",
          "views": "0",
          "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
          "category": "sports",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "414,489,505,782,30348,198081,198499",
          "category_id": "9,74",
          "images": {
            "png": {
              "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
              "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
            },
            "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
          },
          "x-widdershins-oldRef": "#/components/schemas/Icon/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    

    Properties

    Name Type Required Description
    data [Icon] false No description
    metadata Metadata false No description

    IconResponse

    {
      "data": {
        "id": 639788,
        "type": "4",
        "priority": "150.000000",
        "selection": 1,
        "premium": 1,
        "state": 1,
        "description": "Net",
        "colors": "",
        "color": 1,
        "style": 0,
        "stroke": 2,
        "detail": 0,
        "style_id": 132,
        "style_name": "",
        "style_slug": "",
        "style_class": "",
        "family_id": 0,
        "family_name": "",
        "family_slug": "",
        "priority_style": "0.000000",
        "slug": "free-icon/net_639788",
        "license": "2",
        "added": 1511878441,
        "pack_id": 639744,
        "pack_name": "Sport",
        "pack_slug": "packs/sport-21",
        "pack_background": "clouds",
        "pack_priority": "150.000000",
        "pack_items": 100,
        "group_id": 229,
        "team_id": 296,
        "group_slug": "made-by-made-premium",
        "team_name": "Made by Made Premium",
        "team_website": "",
        "downloads": "0",
        "views": "0",
        "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
        "category": "sports",
        "item_equivalent": "0",
        "equivalents": 0,
        "tags_id": "414,489,505,782,30348,198081,198499",
        "category_id": "9,74",
        "images": {
          "png": {
            "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
            "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
          },
          "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
        },
        "x-widdershins-oldRef": "#/components/schemas/Icon/example"
      }
    }
    

    Properties

    Name Type Required Description
    data Icon false No description

    Icon

    {
      "id": 639788,
      "type": "4",
      "priority": "150.000000",
      "selection": 1,
      "premium": 1,
      "state": 1,
      "description": "Net",
      "colors": "",
      "color": 1,
      "style": 0,
      "stroke": 2,
      "detail": 0,
      "style_id": 132,
      "style_name": "",
      "style_slug": "",
      "style_class": "",
      "family_id": 0,
      "family_name": "",
      "family_slug": "",
      "priority_style": "0.000000",
      "slug": "free-icon/net_639788",
      "license": "2",
      "added": 1511878441,
      "pack_id": 639744,
      "pack_name": "Sport",
      "pack_slug": "packs/sport-21",
      "pack_background": "clouds",
      "pack_priority": "150.000000",
      "pack_items": 100,
      "group_id": 229,
      "team_id": 296,
      "group_slug": "made-by-made-premium",
      "team_name": "Made by Made Premium",
      "team_website": "",
      "downloads": "0",
      "views": "0",
      "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
      "category": "sports",
      "item_equivalent": "0",
      "equivalents": 0,
      "tags_id": "414,489,505,782,30348,198081,198499",
      "category_id": "9,74",
      "images": {
        "png": {
          "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
          "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
        },
        "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
      },
      "x-widdershins-oldRef": "#/components/schemas/Icon/example"
    }
    

    Properties

    Name Type Required Description
    id integer false No description
    type integer false No description
    priority string false No description
    selection integer false No description
    premium integer false No description
    state integer false No description
    description string false No description
    colors string false No description
    color integer false No description
    style integer false No description
    stroke integer false No description
    detail integer false No description
    style_id integer false No description
    style_name string false No description
    style_slug string false No description
    style_class string false No description
    family_id integer false No description
    family_name string false No description
    family_slug string false No description
    priority_style string false No description
    slug string false No description
    license string false No description
    added integer false No description
    pack_id integer false No description
    pack_name string false No description
    pack_slug string false No description
    pack_background string false No description
    pack_priority string false No description
    pack_items integer false No description
    group_id integer false No description
    team_id integer false No description
    group_slug string false No description
    team_name string false No description
    team_website string false No description
    downloads string false No description
    views string false No description
    tags string false No description
    category string false No description
    item_equivalent string false No description
    equivalents integer false No description
    tags_id string false No description
    category_id string false No description
    images [any] false No description

    PacksResponse

    {
      "data": [
        {
          "id": 150173,
          "type": "5",
          "priority": "175.033997",
          "selection": 1,
          "premium": 0,
          "state": 1,
          "description": "Team Organization Human  Pictograms",
          "colors": "peter-river",
          "color": 1,
          "style": 3,
          "stroke": 2,
          "detail": 2,
          "style_id": 10,
          "style_name": "Fill",
          "style_slug": "family/pictograms/filled",
          "style_class": "filled",
          "family_id": 5,
          "family_name": "Pictograms",
          "family_slug": "family/pictograms",
          "priority_style": "0.000000",
          "slug": "packs/team-organization-human-pictograms",
          "license": "2",
          "added": 1463669759,
          "pack_id": 0,
          "pack_name": "",
          "pack_slug": "",
          "pack_background": "",
          "pack_priority": "0.000000",
          "pack_items": 30,
          "group_id": 1,
          "team_id": 166,
          "group_slug": "freepik",
          "team_name": "Freepik",
          "team_website": "http://www.freepik.com",
          "downloads": "0",
          "views": "0",
          "tags": "people,business,manager,businessman,worker,stick man,humanpictos",
          "category": "people",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "112,243,21266,21515,22204,180597,189708",
          "category_id": "30,33",
          "images": {
            "sprite": "https://image.flaticon.com/sprites/new_packs/150173-team-organization-human-pictograms.png"
          },
          "x-widdershins-oldRef": "#/components/schemas/Pack/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    

    Properties

    Name Type Required Description
    data [Pack] false No description
    metadata Metadata false No description

    PackResponse

    {
      "data": {
        "id": 150173,
        "type": "5",
        "priority": "175.033997",
        "selection": 1,
        "premium": 0,
        "state": 1,
        "description": "Team Organization Human  Pictograms",
        "colors": "peter-river",
        "color": 1,
        "style": 3,
        "stroke": 2,
        "detail": 2,
        "style_id": 10,
        "style_name": "Fill",
        "style_slug": "family/pictograms/filled",
        "style_class": "filled",
        "family_id": 5,
        "family_name": "Pictograms",
        "family_slug": "family/pictograms",
        "priority_style": "0.000000",
        "slug": "packs/team-organization-human-pictograms",
        "license": "2",
        "added": 1463669759,
        "pack_id": 0,
        "pack_name": "",
        "pack_slug": "",
        "pack_background": "",
        "pack_priority": "0.000000",
        "pack_items": 30,
        "group_id": 1,
        "team_id": 166,
        "group_slug": "freepik",
        "team_name": "Freepik",
        "team_website": "http://www.freepik.com",
        "downloads": "0",
        "views": "0",
        "tags": "people,business,manager,businessman,worker,stick man,humanpictos",
        "category": "people",
        "item_equivalent": "0",
        "equivalents": 0,
        "tags_id": "112,243,21266,21515,22204,180597,189708",
        "category_id": "30,33",
        "images": {
          "sprite": "https://image.flaticon.com/sprites/new_packs/150173-team-organization-human-pictograms.png"
        },
        "x-widdershins-oldRef": "#/components/schemas/Pack/example"
      }
    }
    

    Properties

    Name Type Required Description
    data Pack false No description

    Pack

    {
      "id": 150173,
      "type": "5",
      "priority": "175.033997",
      "selection": 1,
      "premium": 0,
      "state": 1,
      "description": "Team Organization Human  Pictograms",
      "colors": "peter-river",
      "color": 1,
      "style": 3,
      "stroke": 2,
      "detail": 2,
      "style_id": 10,
      "style_name": "Fill",
      "style_slug": "family/pictograms/filled",
      "style_class": "filled",
      "family_id": 5,
      "family_name": "Pictograms",
      "family_slug": "family/pictograms",
      "priority_style": "0.000000",
      "slug": "packs/team-organization-human-pictograms",
      "license": "2",
      "added": 1463669759,
      "pack_id": 0,
      "pack_name": "",
      "pack_slug": "",
      "pack_background": "",
      "pack_priority": "0.000000",
      "pack_items": 30,
      "group_id": 1,
      "team_id": 166,
      "group_slug": "freepik",
      "team_name": "Freepik",
      "team_website": "http://www.freepik.com",
      "downloads": "0",
      "views": "0",
      "tags": "people,business,manager,businessman,worker,stick man,humanpictos",
      "category": "people",
      "item_equivalent": "0",
      "equivalents": 0,
      "tags_id": "112,243,21266,21515,22204,180597,189708",
      "category_id": "30,33",
      "images": {
        "sprite": "https://image.flaticon.com/sprites/new_packs/150173-team-organization-human-pictograms.png"
      },
      "x-widdershins-oldRef": "#/components/schemas/Pack/example"
    }
    

    Properties

    Name Type Required Description
    id integer false No description
    type integer false No description
    priority string false No description
    selection integer false No description
    premium integer false No description
    state integer false No description
    description string false No description
    colors string false No description
    color integer false No description
    style integer false No description
    stroke integer false No description
    detail integer false No description
    style_id integer false No description
    style_name string false No description
    style_slug string false No description
    style_class string false No description
    family_id integer false No description
    family_name string false No description
    family_slug string false No description
    priority_style string false No description
    slug string false No description
    license string false No description
    added integer false No description
    pack_id integer false No description
    pack_name string false No description
    pack_slug string false No description
    pack_background string false No description
    pack_priority string false No description
    pack_items integer false No description
    group_id integer false No description
    team_id integer false No description
    group_slug string false No description
    team_name string false No description
    team_website string false No description
    downloads string false No description
    views string false No description
    tags string false No description
    category string false No description
    item_equivalent string false No description
    equivalents integer false No description
    tags_id string false No description
    category_id string false No description
    images [string] false No description

    CategoriesResponse

    {
      "data": [
        {
          "id": 11,
          "icons": "53",
          "name": "Animals",
          "url": "https://www.flaticon.com/categories/animals",
          "api_resources": {
            "category": "http://localhost:8080/v2/category/11"
          },
          "sprites": {
            "general": "https://image.flaticon.com/sprites/categories/11.png",
            "small": "https://image.flaticon.com/sprites/extension/categories/11.png",
            "share": "https://image.flaticon.com/sprites/share/categories/animals.png"
          },
          "x-widdershins-oldRef": "#/components/schemas/Category/example"
        }
      ],
      "metadata": {
        "page": 1,
        "count": 7,
        "total": 7,
        "x-widdershins-oldRef": "#/components/schemas/Metadata/example"
      }
    }
    

    Properties

    Name Type Required Description
    data [Category] false No description
    metadata Metadata false No description

    CategoryResponse

    {
      "data": {
        "id": 11,
        "icons": "53",
        "name": "Animals",
        "url": "https://www.flaticon.com/categories/animals",
        "api_resources": {
          "category": "http://localhost:8080/v2/category/11"
        },
        "sprites": {
          "general": "https://image.flaticon.com/sprites/categories/11.png",
          "small": "https://image.flaticon.com/sprites/extension/categories/11.png",
          "share": "https://image.flaticon.com/sprites/share/categories/animals.png"
        },
        "x-widdershins-oldRef": "#/components/schemas/Category/example"
      }
    }
    

    Properties

    Name Type Required Description
    data Category false No description

    Category

    {
      "id": 11,
      "icons": "53",
      "name": "Animals",
      "url": "https://www.flaticon.com/categories/animals",
      "api_resources": {
        "category": "http://localhost:8080/v2/category/11"
      },
      "sprites": {
        "general": "https://image.flaticon.com/sprites/categories/11.png",
        "small": "https://image.flaticon.com/sprites/extension/categories/11.png",
        "share": "https://image.flaticon.com/sprites/share/categories/animals.png"
      },
      "x-widdershins-oldRef": "#/components/schemas/Category/example"
    }
    

    Properties

    Name Type Required Description
    id integer false No description
    icons string false No description
    name string false No description
    url string false No description
    api_resources object false No description
    » category string false No description
    sprites object false No description
    » general string false No description
    » small string false No description
    » share string false No description

    CollectionsResponse

    {
      "data": [
        {
          "id": 11,
          "user_id": 434525,
          "name": "purchases",
          "creation_date": "2017-12-13T14:47:57.000Z",
          "modification_date": "",
          "type": "14",
          "mongo_id": 0,
          "color": "",
          "icons": [],
          "x-widdershins-oldRef": "#/components/schemas/SimpleCollection/example"
        }
      ]
    }
    

    Properties

    Name Type Required Description
    data [SimpleCollection] false No description

    SingleCollectionResponse

    {
      "data": {
        "id": 11,
        "user_id": 434525,
        "name": "purchases",
        "creation_date": "2017-12-13T14:47:57.000Z",
        "modification_date": "",
        "type": "14",
        "mongo_id": 0,
        "color": "",
        "icons": [
          {
            "id": 639788,
            "type": "4",
            "priority": "150.000000",
            "selection": 1,
            "premium": 1,
            "state": 1,
            "description": "Net",
            "colors": "",
            "color": 1,
            "style": 0,
            "stroke": 2,
            "detail": 0,
            "style_id": 132,
            "style_name": "",
            "style_slug": "",
            "style_class": "",
            "family_id": 0,
            "family_name": "",
            "family_slug": "",
            "priority_style": "0.000000",
            "slug": "free-icon/net_639788",
            "license": "2",
            "added": 1511878441,
            "pack_id": 639744,
            "pack_name": "Sport",
            "pack_slug": "packs/sport-21",
            "pack_background": "clouds",
            "pack_priority": "150.000000",
            "pack_items": 100,
            "group_id": 229,
            "team_id": 296,
            "group_slug": "made-by-made-premium",
            "team_name": "Made by Made Premium",
            "team_website": "",
            "downloads": "0",
            "views": "0",
            "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
            "category": "sports",
            "item_equivalent": "0",
            "equivalents": 0,
            "tags_id": "414,489,505,782,30348,198081,198499",
            "category_id": "9,74",
            "images": {
              "png": {
                "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
                "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
              },
              "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
            },
            "x-widdershins-oldRef": "#/components/schemas/Icon/example"
          }
        ],
        "x-widdershins-oldRef": "#/components/schemas/Collection/example"
      }
    }
    

    Properties

    Name Type Required Description
    data Collection false No description

    SimpleCollection

    {
      "id": 11,
      "user_id": 434525,
      "name": "purchases",
      "creation_date": "2017-12-13T14:47:57.000Z",
      "modification_date": "",
      "type": "14",
      "mongo_id": 0,
      "color": "",
      "icons": [],
      "x-widdershins-oldRef": "#/components/schemas/SimpleCollection/example"
    }
    

    Properties

    Name Type Required Description
    id integer false No description
    user_id integer false No description
    name string false No description
    creation_date string false No description
    modification_date string false No description
    type integer false No description
    mongo_id integer false No description
    color string false No description

    Collection

    {
      "id": 11,
      "user_id": 434525,
      "name": "purchases",
      "creation_date": "2017-12-13T14:47:57.000Z",
      "modification_date": "",
      "type": "14",
      "mongo_id": 0,
      "color": "",
      "icons": [
        {
          "id": 639788,
          "type": "4",
          "priority": "150.000000",
          "selection": 1,
          "premium": 1,
          "state": 1,
          "description": "Net",
          "colors": "",
          "color": 1,
          "style": 0,
          "stroke": 2,
          "detail": 0,
          "style_id": 132,
          "style_name": "",
          "style_slug": "",
          "style_class": "",
          "family_id": 0,
          "family_name": "",
          "family_slug": "",
          "priority_style": "0.000000",
          "slug": "free-icon/net_639788",
          "license": "2",
          "added": 1511878441,
          "pack_id": 639744,
          "pack_name": "Sport",
          "pack_slug": "packs/sport-21",
          "pack_background": "clouds",
          "pack_priority": "150.000000",
          "pack_items": 100,
          "group_id": 229,
          "team_id": 296,
          "group_slug": "made-by-made-premium",
          "team_name": "Made by Made Premium",
          "team_website": "",
          "downloads": "0",
          "views": "0",
          "tags": "net,sport,sports,sunny,summertime,beach volleyball,sports and competition",
          "category": "sports",
          "item_equivalent": "0",
          "equivalents": 0,
          "tags_id": "414,489,505,782,30348,198081,198499",
          "category_id": "9,74",
          "images": {
            "png": {
              "128": "https://image.flaticon.com/icons/png/128/639/639788.png",
              "512": "https://image.flaticon.com/icons/png/512/639/639788.png"
            },
            "svg": "https://img-premium.flaticon.com/svg/639/639788.svg?token=exp=1630484178~hmac=481acd4399e7b7e38b070379dc0d8540"
          },
          "x-widdershins-oldRef": "#/components/schemas/Icon/example"
        }
      ],
      "x-widdershins-oldRef": "#/components/schemas/Collection/example"
    }
    

    Properties

    Name Type Required Description
    id integer false No description
    user_id integer false No description
    name string false No description
    creation_date string false No description
    modification_date string false No description
    type integer false No description
    mongo_id integer false No description
    color string false No description
    icons [Icon] false No description