Topics

Topics help you organize your Ideas into groups, much like tags. An Ideas can belong to multiple Topics.

Topic object

Topic have the following fields

Field	Details
idx string	A unique identifier for the topic
name string	Name of the topic
idea_count number	Number of ideas that have been tagged with this Topic
order number	The position of the topic in the topic list

Endpoints

You can use the following endpoints to manage Topics

List topics

Returns a list of topics

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

Query parameters

Response

200400

Successfully returned a list of topics

Body

application/json

dataarray of Topic (object)

paginationPagination (object)

Request

JavaScriptCurlPython

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

Response

200400

{
  "data": [
    {
      "idx": "topic_abcd1234",
      "name": "New features",
      "idea_count": 0,
      "order": 0,
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

Create a topic

Create a new topic

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

Body

application/json

namestring

Response

200400

Successfully created a new topic

Body

application/json

idx*string

A unique identifier for the topic

Example: "topic_abcd1234"

namestring

Name of the topic

Example: "New features"

idea_countnumber

Number of ideas that have been tagged with this Topic

ordernumber

The position of the topic in the topic list

created_atstring

The date & time the Topic was last updated (UTC timezone)

updated_atstring

The date & time the Topic was last updated (UTC timezone)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/topics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "idx": "topic_abcd1234",
  "name": "New features",
  "idea_count": 0,
  "order": 0,
  "created_at": "text",
  "updated_at": "text"
}

Update a topic

Update a Topic

POSThttps://api.frill.co/v1/topics/{topicIdx}

Path parameters

topicIdx*string

Body

application/json

namestring

Response

200400

Successfully updated a topic

Body

application/json

idx*string

A unique identifier for the topic

Example: "topic_abcd1234"

namestring

Name of the topic

Example: "New features"

idea_countnumber

Number of ideas that have been tagged with this Topic

ordernumber

The position of the topic in the topic list

created_atstring

The date & time the Topic was last updated (UTC timezone)

updated_atstring

The date & time the Topic was last updated (UTC timezone)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/topics/{topicIdx}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "idx": "topic_abcd1234",
  "name": "New features",
  "idea_count": 0,
  "order": 0,
  "created_at": "text",
  "updated_at": "text"
}

Delete a topic

Delete a Topic

DELETEhttps://api.frill.co/v1/topics/{topicIdx}

Path parameters

topicIdx*string

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/topics/{topicIdx}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

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