> For the complete documentation index, see [llms.txt](https://developers.frill.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.frill.co/api/reference/ideas.md).
# Ideas
## 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 |
| url
string
| Direct link to the idea on the public board |
| 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\_pinned
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` |
| priority\_score
number
| The computed composite prioritization score (`0` when the idea has not been prioritized — see `is_prioritized`) |
| priority\_score\_normalized
number
| The prioritization score normalized to a 0-100 scale (relative to the company's maximum possible benefit score) |
| priority\_score\_benefits
number
| The benefit component of the prioritization score |
| priority\_score\_costs
number
| The cost component of the prioritization score |
| is\_prioritized
boolean
| Whether every required prioritization factor has been scored for this idea |
| priorities
object
| The idea's raw 0-10 score for each prioritization factor, keyed by the factor's `company_priority` idx (see Prioritization below) |
| 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 |
## Prioritization
Ideas carry prioritization data so you can pull priority scores into your own tools instead of only sorting by votes.
* Each idea returns a composite `priority_score` (plus `priority_score_normalized`, `priority_score_benefits` and `priority_score_costs`), and a `priorities` map of the raw 0-10 score for each factor, keyed by that factor's `company_priority` idx.
* The factor definitions (name, benefit/cost, weight) are returned **once per response** in `meta.company_priorities` — use each factor's `idx` to interpret the per-idea `priorities` map. The `votes` factor, when configured, is derived from the idea's votes and included in the map.
* `is_prioritized` is `true` only when every required factor has been scored. Unprioritized ideas report a `priority_score` of `0`.
* On `GET /ideas` you can sort by `priority_score` (`sortBy=priority_score`) and filter by prioritization state with `is_prioritized` (`true` for fully-prioritized ideas, `false` for those still needing prioritization).
## Endpoints
You can use the following endpoints to manage Ideas
{% openapi src="/files/nvWLOcVQy6aMzLlDG4cO" path="/ideas" method="get" %}
[ideas.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-552db8b6245713dd61480fa22058c96f03b58888%2Fideas.yaml?alt=media)
{% endopenapi %}
{% openapi src="/files/nvWLOcVQy6aMzLlDG4cO" path="/ideas/search" method="get" %}
[ideas.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-552db8b6245713dd61480fa22058c96f03b58888%2Fideas.yaml?alt=media)
{% endopenapi %}
{% openapi src="/files/nvWLOcVQy6aMzLlDG4cO" path="/ideas" method="post" %}
[ideas.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-552db8b6245713dd61480fa22058c96f03b58888%2Fideas.yaml?alt=media)
{% endopenapi %}
{% openapi src="/files/nvWLOcVQy6aMzLlDG4cO" path="/ideas/{ideaIdxOrSlug}" method="get" %}
[ideas.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-552db8b6245713dd61480fa22058c96f03b58888%2Fideas.yaml?alt=media)
{% endopenapi %}
{% openapi src="/files/nvWLOcVQy6aMzLlDG4cO" path="/ideas/{ideaIdx}" method="post" %}
[ideas.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-552db8b6245713dd61480fa22058c96f03b58888%2Fideas.yaml?alt=media)
{% endopenapi %}
{% openapi src="/files/nvWLOcVQy6aMzLlDG4cO" path="/ideas/{ideaIdx}" method="delete" %}
[ideas.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-552db8b6245713dd61480fa22058c96f03b58888%2Fideas.yaml?alt=media)
{% endopenapi %}