Developers
  • Welcome!
  • API
    • Quick Start
    • Authentication
    • Responses
    • Pagination
    • Reference
      • Announcements
      • Announcement Categories
      • Ideas
      • Statuses
      • Topics
      • Followers
      • Votes
      • --- Coming soon ---
      • Comments
      • Notes
Powered by GitBook
On this page
  1. API
  2. Reference

Topics

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

PreviousStatusesNextFollowers

Last updated 7 months ago

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

Create a topic

Update a topic

Delete a topic

get

Returns a list of topics

Authorizations
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
GET /v1/topics HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
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"
  }
}
delete

Delete a Topic

Authorizations
Path parameters
topicIdxstringRequired
Responses
200
Request was successful
application/json
400
Invalid request
application/json
delete
DELETE /v1/topics/{topicIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

{
  "success": true,
  "message": "Request was successful"
}
  • Topic object
  • Endpoints
  • GET/topics
  • POST/topics
  • POST/topics/{topicIdx}
  • DELETE/topics/{topicIdx}
post

Create a new topic

Authorizations
Body
namestringOptional
Responses
200
Successfully created a new topic
application/json
400
Invalid request
application/json
post
POST /v1/topics HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
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"
}
post

Update a Topic

Authorizations
Path parameters
topicIdxstringRequired
Body
namestringOptional
Responses
200
Successfully updated a topic
application/json
400
Invalid request
application/json
post
POST /v1/topics/{topicIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
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"
}