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

Field	Details
idx string	A unique identifier for the idea
name string	The name of the idea
slug string	The URL slug of the idea
excerpt string	A short excerpt or summary of the idea
description string	The text description of the idea (legacy field, use content fields for structured data)
content array	Structured content as a JSON array (similar to Slate.js/ProseMirror format)
content_html string	Content rendered as HTML
content_markdown string	Content rendered as Markdown
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: approved|needs-approval|rejected
created_at string	The date & time the idea was created in UTC timezone
updated_at string	The date & time the idea was last updated (UTC timezone)
author object	Author of the idea
status object	Status of the idea
topics array	Topics associated with the idea
attachments array	Files and images attached to this idea

Endpoints

You can use the following endpoints to manage Ideas

get

Returns a list of ideas

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Query parameters

limitintegerOptional

Limits the number of items on a page

Default: 20

afterstringOptional

The after cursor - used for pagination

sortstring · enumOptional

The field so sort by

Default: created_atPossible values:

sortBystring · enumOptional

The direction to sort

Default: descPossible values:

Responses

200

Successfully returned a list of ideas

application/json

400

Invalid request

application/json

get

/ideas

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "idx": "idea_abcd1234",
      "name": "New idea",
      "slug": "new-idea",
      "excerpt": "A brief summary of this idea",
      "description": "This is a new idea from a customer",
      "content": [
        {
          "type": "paragraph",
          "children": [
            {
              "text": "This is a new idea from a customer"
            }
          ]
        }
      ],
      "content_html": "<p>This is a new idea from a customer</p>",
      "content_markdown": "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": "approved",
      "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"
          }
        ]
      ],
      "attachments": [
        {
          "idx": "attachment_abcd1234",
          "name": "screenshot.png",
          "url": "https://cdn.frill.co/files/example.png",
          "type": "image/png",
          "created_at": "text",
          "updated_at": "text"
        }
      ]
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

post

Create a new idea

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Body

application/json

author_idxstringRequired

A unique identifier for the idea author

Example: follower_abcd1234

namestringRequired

The name of the idea

Example: New idea

descriptionstringRequired

The text description of the idea

Example: This is a new idea from a customer

status_idxstringOptional

A unique identifier for the idea status

Example: status_abcd1234

topic_idxsarrayOptional

array of unique identifiers for the idea topics

is_pinedbooleanOptional

Has the idea been pinned to the top

is_archivedbooleanOptional

Denotes if this idea has been archived

show_in_roadmapbooleanOptional

Should the idea be displayed in the Roadmap view

approval_statusstring · enumOptional

The approval status of the idea. When creating an idea via REST API, you can optionally set this value.

Example: needs-approvalPossible values:

Responses

200

Successfully created a new idea

application/json

400

Invalid request

application/json

post

/ideas

HTTPcURLJavaScriptPython

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

{
  "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,
  "approval_status": "needs-approval"
}

{
  "data": {
    "idx": "idea_abcd1234",
    "name": "New idea",
    "slug": "new-idea",
    "excerpt": "A brief summary of this idea",
    "description": "This is a new idea from a customer",
    "content": [
      {
        "type": "paragraph",
        "children": [
          {
            "text": "This is a new idea from a customer"
          }
        ]
      }
    ],
    "content_html": "<p>This is a new idea from a customer</p>",
    "content_markdown": "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": "approved",
    "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"
        }
      ]
    ],
    "attachments": [
      {
        "idx": "attachment_abcd1234",
        "name": "screenshot.png",
        "url": "https://cdn.frill.co/files/example.png",
        "type": "image/png",
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

get

Get an Idea

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

ideaIdxOrSlugstringRequired

IDX or Slug of the Idea

Responses

200

Return idea

application/json

400

Invalid request

application/json

get

/ideas/{ideaIdxOrSlug}

HTTPcURLJavaScriptPython

GET /v1/ideas/{ideaIdxOrSlug} HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "idx": "idea_abcd1234",
    "name": "New idea",
    "slug": "new-idea",
    "excerpt": "A brief summary of this idea",
    "description": "This is a new idea from a customer",
    "content": [
      {
        "type": "paragraph",
        "children": [
          {
            "text": "This is a new idea from a customer"
          }
        ]
      }
    ],
    "content_html": "<p>This is a new idea from a customer</p>",
    "content_markdown": "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": "approved",
    "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"
        }
      ]
    ],
    "attachments": [
      {
        "idx": "attachment_abcd1234",
        "name": "screenshot.png",
        "url": "https://cdn.frill.co/files/example.png",
        "type": "image/png",
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

post

Update an Idea

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

ideaIdxstringRequired

IDX of the Idea

Body

application/json

author_idxstringRequired

A unique identifier for the idea author

Example: follower_abcd1234

namestringRequired

The name of the idea

Example: New idea

descriptionstringRequired

The text description of the idea

Example: This is a new idea from a customer

status_idxstringOptional

A unique identifier for the idea status

Example: status_abcd1234

topic_idxsarrayOptional

array of unique identifiers for the idea topics

is_pinedbooleanOptional

Has the idea been pinned to the top

is_archivedbooleanOptional

Denotes if this idea has been archived

show_in_roadmapbooleanOptional

Should the idea be displayed in the Roadmap view

approval_statusstring · enumOptional

The approval status of the idea. When creating an idea via REST API, you can optionally set this value.

Example: needs-approvalPossible values:

Responses

200

Successfully updated an idea

application/json

400

Invalid request

application/json

post

/ideas/{ideaIdx}

HTTPcURLJavaScriptPython

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

{
  "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,
  "approval_status": "needs-approval"
}

{
  "data": {
    "idx": "idea_abcd1234",
    "name": "New idea",
    "slug": "new-idea",
    "excerpt": "A brief summary of this idea",
    "description": "This is a new idea from a customer",
    "content": [
      {
        "type": "paragraph",
        "children": [
          {
            "text": "This is a new idea from a customer"
          }
        ]
      }
    ],
    "content_html": "<p>This is a new idea from a customer</p>",
    "content_markdown": "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": "approved",
    "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"
        }
      ]
    ],
    "attachments": [
      {
        "idx": "attachment_abcd1234",
        "name": "screenshot.png",
        "url": "https://cdn.frill.co/files/example.png",
        "type": "image/png",
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

delete

Delete an Idea

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

ideaIdxstringRequired

IDX of the Idea

Responses

200

Request was successful

application/json

400

Invalid request

application/json

delete

/ideas/{ideaIdx}

HTTPcURLJavaScriptPython

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

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