Idea states

Idea states represent your workflow columns (e.g. Planned, In development, Shipped). Use these IDs when setting the status field on ideas.

List idea states

GET /api/v1/idea-states/

Retrieve a paginated list of idea states for your company.

Query parameters

Parameter	Type	Required	Default	Description
`limit`	integer	No	20	Results per page (max 100).
`offset`	integer	No	0	Number of results to skip.

Example request

curl -sS \
  -H 'Authorization: Api-Key scalar*live*...' \
  'https://<your-host>/api/v1/idea-states/'

Success response (200 OK)

{
    "results": [
        {
            "id": 1,
            "name": "Planned",
            "type": "PLANNED",
            "colour": "#8B5CF6",
            "order": 3,
            "show_on_roadmap": true,
            "slug": "planned-abc123"
        }
    ],
    "count": 1
}

Objects

Idea State object

Field	Type	Description
`id`	integer	Unique internal ID.
`name`	string	State name.
`type`	string	Internal state type (e.g. `PLANNED`, `IN_PROGRESS`).
`colour`	string	Hex display colour.
`order`	integer	Display order in the roadmap and dashboard.
`show_on_roadmap`	boolean	Whether this state is visible on the public roadmap.
`slug`	string	URL-safe identifier.