Skip to content

Ideas API

List and filter ideas

Operations

List ideas

Request

Returns a paginated, enriched list of ideas for the authenticated account. Supports pagination via page/pageSize, sorting, and filtering by component, owner, and creation date range. Only active ideas are returned.

Security
ApiToken
Query
pageinteger, >= 1

1-based page number.

Default:1
pageSizeinteger, [ 1 .. 1000 ]

Number of items per page.

Default:500
sortBystring

Field to sort by.

Default:"createdAt"
sortDirstring

Sort direction.

Default:"desc"
Enum:"asc""desc"
componentIdstring^[0-9a-fA-F]{24}$

Filter by product component (Bagel ObjectId).

ownerIdstring^[0-9a-fA-F]{24}$

Filter by idea owner (Bagel user ObjectId).

createdAtStartstring, (date-time)

Return ideas created on or after this ISO 8601 date-time (inclusive).

Example:createdAtStart=2024-12-01T00:00:00.000Z
createdAtEndstring, (date-time)

Return ideas created on or before this ISO 8601 date-time (inclusive).

Example:createdAtEnd=2024-12-26T00:00:00.000Z
stateArray of strings

Filter by idea state. Repeat the parameter for multiple values. Defaults to ["active"] when omitted.

Items Enum:"active""generated""deleted"
Example:state=active&state=generated
GET
/v2/ideas
curl -i -X GET \
  'https://api.bagel.ai/v2/ideas?page=1&pageSize=500&sortBy=createdAt&sortDir=asc&componentId=string&ownerId=string&createdAtStart=2024-12-01T00%3A00%3A00.000Z&createdAtEnd=2024-12-26T00%3A00%3A00.000Z&state=active%2Cgenerated' \
  -H 'authorization: YOUR_API_KEY_HERE'

Responses

A paginated list of ideas

Bodyapplication/json
itemsArray of objects(ApiIdea)
totalinteger

Total number of ideas matching the filters (ignores pagination).

Example:1234
hasMoreboolean

Whether more pages are available after the current one.

Example:true
Response
{
  "total": 1234,
  "hasMore": true,
  "items": [
    { … }
  ]
}