# Ideas

## Idea object

Ideas have the following fields

| Field                                                | Details                                                                                 |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------- |
| <p><strong>idx</strong><br>string</p>                | A unique identifier for the idea                                                        |
| <p><strong>name</strong><br>string</p>               | The name of the idea                                                                    |
| <p><strong>slug</strong><br>string</p>               | The URL slug of the idea                                                                |
| <p><strong>excerpt</strong><br>string</p>            | A short excerpt or summary of the idea                                                  |
| <p><strong>description</strong><br>string</p>        | The text description of the idea (legacy field, use content fields for structured data) |
| <p><strong>content</strong><br>array</p>             | Structured content as a JSON array (similar to Slate.js/ProseMirror format)             |
| <p><strong>content\_html</strong><br>string</p>      | Content rendered as HTML                                                                |
| <p><strong>content\_markdown</strong><br>string</p>  | Content rendered as Markdown                                                            |
| <p><strong>cover\_image</strong><br>string</p>       | Url of the image displayed as the cover on the Roadmap view                             |
| <p><strong>vote\_count</strong><br>number</p>        | Number of votes this idea has received                                                  |
| <p><strong>comment\_count</strong><br>number</p>     | Number of comments on this idea                                                         |
| <p><strong>note\_count</strong><br>number</p>        | Number of internal notes on this idea                                                   |
| <p><strong>is\_pined</strong><br>boolean</p>         | Has the idea been pinned to the top                                                     |
| <p><strong>is\_bug</strong><br>boolean</p>           | Denotes if this idea is a bug                                                           |
| <p><strong>is\_archived</strong><br>boolean</p>      | Denotes if this idea has been archived                                                  |
| <p><strong>is\_completed</strong><br>boolean</p>     | Denotes if this idea is considered completed / finished                                 |
| <p><strong>show\_in\_roadmap</strong><br>boolean</p> | Should the idea be displayed in the Roadmap view                                        |
| <p><strong>approval\_status</strong><br>string</p>   | The approval status of the idea: `approved\|needs-approval\|rejected`                   |
| <p><strong>created\_at</strong><br>string</p>        | The date & time the idea was created in UTC timezone                                    |
| <p><strong>updated\_at</strong><br>string</p>        | The date & time the idea was last updated (UTC timezone)                                |
| <p><strong>author</strong><br>object</p>             | Author of the idea                                                                      |
| <p><strong>status</strong><br>object</p>             | Status of the idea                                                                      |
| <p><strong>topics</strong><br>array</p>              | Topics associated with the idea                                                         |
| <p><strong>attachments</strong><br>array</p>         | Files and images attached to this idea                                                  |

## Endpoints

You can use the following endpoints to manage Ideas

{% openapi src="<https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media>" 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-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media)
{% endopenapi %}

{% openapi src="<https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media>" 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-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media)
{% endopenapi %}

{% openapi src="<https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media>" 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-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media)
{% endopenapi %}

{% openapi src="<https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media>" 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-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media)
{% endopenapi %}

{% openapi src="<https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media>" 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-79829d0db554abf961edceaf6a90fda3f0d7a54b%2Fideas.yaml?alt=media)
{% endopenapi %}