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

get

/topics

Authorizations

Query parameters

limitinteger

Limits the number of items on a page

offsetinteger

Specifies the page number of the topics to be displayed

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.frill.co/v1/topics' \
  --header 'Authorization: Basic username:password'

200

400

200

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

Successfully returned a list of topics

Create a topic

Create a new topic

post

/topics

Authorizations

Body

namestring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.frill.co/v1/topics' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json'

200

400

200

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

Successfully created a new topic

Update a topic

Update a Topic

post

/topics/{topicIdx}

Authorizations

Path parameters

topicIdxstringrequired

Body

namestring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.frill.co/v1/topics/{topicIdx}' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json'

200

400

200

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

Successfully updated a topic

Delete a topic

Delete a Topic

delete

/topics/{topicIdx}

Authorizations

Path parameters

topicIdxstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.frill.co/v1/topics/{topicIdx}' \
  --header 'Authorization: Basic username:password'

200

400

200

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

Request was successful