Skip to content

Get idea by id

Request

Returns one idea for the authenticated account, in the same shape as an item of the /v2/ideas list. Any state is served; only an unknown id is a 404.

Security
ApiToken
Path
idstring^[0-9a-fA-F]{24}$required

Bagel ObjectId of the idea.

GET
/v2/ideas/{id}
curl -i -X GET \
  'https://api.bagel.ai/v2/ideas/{id}' \
  -H 'authorization: YOUR_API_KEY_HERE'

Responses

The idea

Bodyapplication/json
idstring

Unique Bagel ID of the idea

Example:"12345"
titlestring

The idea title

Example:"New Feature Implementation"
descriptionstring

The idea description

Example:"This idea proposes a new feature for improving user experience."
prioritystring

Custom options defined by the user in Bagel. Typically values like High, Medium, or Low.

Example:"High"
domainstring

Broad business domains that are often connected to several product areas. These represent the main domains of the company.

Example:"Product"
product_areastring

More specific area of the business product related to the idea.

Example:"UX Design"
product_sub_areastring

Further refines the product categorization.

Example:"Prototyping"
statusstring

The current status set for the idea

Example:"Pending"
statestring

Lifecycle state of the idea in Bagel.

Enum:"active""generated""deleted"
Example:"active"
status_infoobject

Final display status derived from idea status and linked delivery item, using account status alias mappings

ownerobject

A Bagel user associated with this idea

delivery_itemobject or null

External item linked to the idea (usually a Jira issue). Null when the idea has no linked delivery item.

parent_idea_idstring or null

Bagel ID of the parent idea when this idea is a sub-idea. Null for a root idea.

Example:"6818c2100e46cea9d81234556"
created_atstring, (date-time)

Timestamp when the idea was initially created

Example:"2023-12-01T10:00:00.000Z"
updated_atstring, (date-time)

Timestamp when any idea fields were last updated (title, description, priority, status, owner, etc.)

Example:"2023-12-05T15:00:00.000Z"
impactobject

Aggregated impact properties for the idea, keyed by impact property name. Each entry contains assigned, suggested, and total values. Impact properties are defined in the idea configuration.

Example:
{
  "totalRevenue": {
    "label": "Total Revenue",
    "assigned": 50000,
    "suggested": 75000,
    "total": 125000
  },
  "companiesCount": {
    "label": "Companies",
    "assigned": 10,
    "suggested": 5,
    "total": 15
  }
}
tagsArray of objects(ApiIdeaTag)

Tags applied to the idea, as a flat list. Only tags in the default uncategorized "Tags" group (field_path "tags") are returned; tags belonging to an account-configured tag category are not exposed. An idea with no such tags returns an empty array.

Example:
[
  {
    "id": "64f1a2b3c4d5e6f7a8b9c0d1",
    "name": "Needs Design"
  }
]
Response
{
  "id": "12345",
  "title": "New Feature Implementation",
  "description": "This idea proposes a new feature for improving user experience.",
  "priority": "High",
  "domain": "Product",
  "product_area": "UX Design",
  "product_sub_area": "Prototyping",
  "status": "Pending",
  "state": "active",
  "status_info": {
    "internal_status": "In QA",
    "external_status": "In Q3 2026"
  },
  "link": "https://app.bagel.ai/idea/12345",
  "owner": {
    "id": "abc123",
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "delivery_item": {
    "id": "delivery123",
    "origin": "jira",
    "origin_id": "10907",
    "title": "2FA Implementation",
    "description": "Implement 2FA for all users.",
    "status": "In Progress",
    "link": "https://delivery.example.com"
  },
  "parent_idea_id": "6818c2100e46cea9d81234556",
  "created_at": "2023-12-01T10:00:00.000Z",
  "updated_at": "2023-12-05T15:00:00.000Z",
  "impact": {
    "totalRevenue": { … },
    "companiesCount": { … }
  },
  "tags": [
    { … }
  ]
}