Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API Key

Your API requests are authenticated using an API Key. Any request that doesn't include an API Key will return an error.

You can request an API Key from the Frill Dashboard at any time.

Company Settings | Frill.co

For more details on Authenticating API requests with an API Key jump into the Authentication section.

pageAuthentication

Make your first request

To make your first request, send an authenticated request to the Ideas endpoint. This will return a list of your current Ideas.

Returns a list of ideas

GEThttps://api.frill.co/v1/ideas

Query parameters

Response

200400

Successfully returned a list of ideas

Body

application/json

dataarray of Idea (object)

paginationPagination (object)

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/ideas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "idx": "idea_abcd1234",
      "name": "New idea",
      "slug": "new-idea",
      "description": "This is a new idea from a customer",
      "cover_image": "https://example.com/example.jpg",
      "vote_count": 0,
      "comment_count": 0,
      "note_count": 0,
      "is_pined": false,
      "is_bug": false,
      "is_archived": false,
      "is_completed": false,
      "show_in_roadmap": false,
      "approval_status": "text",
      "created_at": "text",
      "updated_at": "text",
      "author": {
        "idx": "user_abcd1234",
        "name": "John Smith",
        "avatar": "https://example.com/example.jpg"
      },
      "status": {
        "idx": "status_abcd1234",
        "name": "Completed",
        "color": "#6392D9"
      },
      "topics": [
        [
          {
            "idx": "topic_abcd1234",
            "name": "New feature"
          }
        ]
      ]
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

Take a look at how you might call this method using curl:

curl

curl https://api.frill.co/v1/ideas  
    -u YOUR_API_KEY: