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
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
Limits the number of items on a page
20
The after cursor - used for pagination
The field so sort by
created_at
Possible values: The direction to sort
desc
Possible values: GET /v1/ideas HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"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": 1,
"comment_count": 1,
"note_count": 1,
"is_pined": true,
"is_bug": true,
"is_archived": true,
"is_completed": true,
"show_in_roadmap": true,
"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
A unique identifier for the idea author
follower_abcd1234
The name of the idea
New idea
The text description of the idea
This is a new idea from a customer
A unique identifier for the idea status
status_abcd1234
array of unique identifiers for the idea topics
Has the idea been pinned to the top
Denotes if this idea has been archived
Should the idea be displayed in the Roadmap view
POST /v1/ideas HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 208
{
"author_idx": "follower_abcd1234",
"name": "New idea",
"description": "This is a new idea from a customer",
"status_idx": "status_abcd1234",
"topic_idxs": [],
"is_pined": true,
"is_archived": true,
"show_in_roadmap": true
}
{
"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": 1,
"comment_count": 1,
"note_count": 1,
"is_pined": true,
"is_bug": true,
"is_archived": true,
"is_completed": true,
"show_in_roadmap": true,
"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
IDX or Slug of the Idea
GET /v1/ideas/{ideaIdxOrSlug} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"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": 1,
"comment_count": 1,
"note_count": 1,
"is_pined": true,
"is_bug": true,
"is_archived": true,
"is_completed": true,
"show_in_roadmap": true,
"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
IDX of the Idea
A unique identifier for the idea author
follower_abcd1234
The name of the idea
New idea
The text description of the idea
This is a new idea from a customer
A unique identifier for the idea status
status_abcd1234
array of unique identifiers for the idea topics
Has the idea been pinned to the top
Denotes if this idea has been archived
Should the idea be displayed in the Roadmap view
POST /v1/ideas/{ideaIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 208
{
"author_idx": "follower_abcd1234",
"name": "New idea",
"description": "This is a new idea from a customer",
"status_idx": "status_abcd1234",
"topic_idxs": [],
"is_pined": true,
"is_archived": true,
"show_in_roadmap": true
}
{
"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": 1,
"comment_count": 1,
"note_count": 1,
"is_pined": true,
"is_bug": true,
"is_archived": true,
"is_completed": true,
"show_in_roadmap": true,
"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
IDX of the Idea
DELETE /v1/ideas/{ideaIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"success": true,
"message": "Request was successful"
}
Last updated