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

get

Returns a list of topics

Authorizations

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Query parameters

limitintegerOptional

Limits the number of items on a page

offsetintegerOptional

Specifies the page number of the topics to be displayed

Responses

200

Successfully returned a list of topics

application/json

400

Invalid request

application/json

get/topics

GET /v1/topics HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a topic

post

Create a new topic

Authorizations

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Body

namestringOptional

Responses

200

Successfully created a new topic

application/json

idxstringRequired

A unique identifier for the topic

Example: topic_abcd1234

namestringOptional

Name of the topic

Example: New features

idea_countnumberOptional

Number of ideas that have been tagged with this Topic

ordernumberOptional

The position of the topic in the topic list

created_atstringOptional

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

updated_atstringOptional

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

400

Invalid request

application/json

post/topics

POST /v1/topics HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

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

Update a topic

post

Update a Topic

Authorizations

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

topicIdxstringRequired

Body

namestringOptional

Responses

200

Successfully updated a topic

application/json

idxstringRequired

A unique identifier for the topic

Example: topic_abcd1234

namestringOptional

Name of the topic

Example: New features

idea_countnumberOptional

Number of ideas that have been tagged with this Topic

ordernumberOptional

The position of the topic in the topic list

created_atstringOptional

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

updated_atstringOptional

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

400

Invalid request

application/json

post/topics/{topicIdx}

POST /v1/topics/{topicIdx} HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

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

Delete a topic

delete

Delete a Topic

Authorizations

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

topicIdxstringRequired

Responses

200

Request was successful

application/json

successbooleanOptional

messagestringOptionalExample: Request was successful

400

Invalid request

application/json

delete/topics/{topicIdx}

DELETE /v1/topics/{topicIdx} HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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