API Docs Help

API Quickstart

In this section, you'll find a step-by-step guide to quickly start using the API.

Prerequisites

Before going forward, you will need

  • Flat Icons API account

  • API access token

Authentication

To authenticate during the API calls, all you have to do is to include an Authorization header:

  • Authorization: Bearer <access_token>

Please see the examples below.

Making Your First Request

To test your access token, you can make the following call to the API. This will give you a list of icons related to education.

GET /api/v1/search?name=education HTTP/1.1 Host: webapp.flat-icons.com Authorization: Bearer YOUR_ACCESS_TOKEN

If the server responds with a status code 200, you are good to go.

Next Steps

See the API Reference for more details.

Last modified: 29 March 2024