Ideas

Ideas are feedback or suggestions submitted by customers to your Frill account. Each idea can be assigned a Status and categorized under multiple Topics.

Idea object

Ideas have the following fields

Field	Details
idx string	A unique identifier for the idea
name string	The name of the idea
slug string	The URL slug of the idea
description string	The text description of the idea
cover_image string	Url of the image displayed as the cover on the Roadmap view
vote_count number	Number of votes this idea has received
comment_count number	Number of comments on this idea
note_count number	Number of internal notes on this idea
is_pined boolean	Has the idea been pinned to the top
is_bug boolean	Denotes if this idea is a bug
is_archived boolean	Denotes if this idea has been archived
is_completed boolean	Denotes if this idea is considered completed / finished
show_in_roadmap boolean	Should the idea be displayed in the Roadmap view
approval_status string	The approval status of the idea
created_at string	The date & time the idea was created in UTC timezone
author object	Author of the idea
status object	Status of the idea
topics array	Topics associated with the idea

Endpoints

You can use the following endpoints to manage 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

JavaScriptCurlPython

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

Response

200400

{
  "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"
  }
}

Create a new idea

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

Body

application/json

author_idx*string

A unique identifier for the idea author

Example: "follower_abcd1234"

name*string

The name of the idea

Example: "New idea"

description*string

The text description of the idea

Example: "This is a new idea from a customer"

status_idxstring

A unique identifier for the idea status

Example: "status_abcd1234"

topic_idxsarray

array of unique identifiers for the idea topics

is_pinedboolean

Has the idea been pinned to the top

is_archivedboolean

Denotes if this idea has been archived

show_in_roadmapboolean

Should the idea be displayed in the Roadmap view

Response

200400

Return idea

Body

application/json

dataIdea (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/ideas', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "author_idx": "follower_abcd1234",
      "name": "New idea",
      "description": "This is a new idea from a customer"
    }),
});
const data = await response.json();

Response

200400

{
  "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"
        }
      ]
    ]
  }
}

Get an Idea

GEThttps://api.frill.co/v1/ideas/{ideaIdxOrSlug}

Path parameters

ideaIdxOrSlug*string

IDX or Slug of the Idea

Response

200400

Return idea

Body

application/json

dataIdea (object)

Request

JavaScriptCurlPython

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

Response

200400

{
  "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"
        }
      ]
    ]
  }
}

Update an Idea

POSThttps://api.frill.co/v1/ideas/{ideaIdx}

Path parameters

ideaIdx*string

IDX of the Idea

Body

application/json

author_idx*string

A unique identifier for the idea author

Example: "follower_abcd1234"

name*string

The name of the idea

Example: "New idea"

description*string

The text description of the idea

Example: "This is a new idea from a customer"

status_idxstring

A unique identifier for the idea status

Example: "status_abcd1234"

topic_idxsarray

array of unique identifiers for the idea topics

is_pinedboolean

Has the idea been pinned to the top

is_archivedboolean

Denotes if this idea has been archived

show_in_roadmapboolean

Should the idea be displayed in the Roadmap view

Response

200400

Return idea

Body

application/json

dataIdea (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/ideas/{ideaIdx}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "author_idx": "follower_abcd1234",
      "name": "New idea",
      "description": "This is a new idea from a customer"
    }),
});
const data = await response.json();

Response

200400

{
  "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"
        }
      ]
    ]
  }
}

Delete an Idea

DELETEhttps://api.frill.co/v1/ideas/{ideaIdx}

Path parameters

ideaIdx*string

IDX of the Idea

Response

200400

Request was successful

Body

application/json

successboolean

messagestring

Example: "Request was successful"

Request

JavaScriptCurlPython

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

Response

200400

{
  "success": false,
  "message": "Request was successful"
}