Skip to content

Evidences API

List and filter evidence

Operations

List evidence

Request

Returns a paginated, enriched list of evidence for the authenticated account. Supports cursor-style pagination via page/pageSize, sorting, and filtering by evidence id, component, owner, idea, account/org, origin, origin id, business name, creation and update date ranges, and lifecycle state.

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"
idsArray of strings

Filter by evidence IDs (Bagel ObjectIds).

Example:ids=5f8d0d55b54764421b7156c3&ids=5f8d0d55b54764421b7156c4
componentIdstring^[0-9a-fA-F]{24}$

Filter by product component (Bagel ObjectId).

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

Filter by evidence owner (Bagel user ObjectId).

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

Filter by linked idea (Bagel ObjectId).

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

Filter by linked company/organization (Bagel ObjectId).

originstring

Filter by the source system the evidence originated from.

Example:origin=salesforce
originIdsArray of strings

Filter by evidence IDs in the source system (the origin_id field).

Example:originIds=SFOpporunityId-123&originIds=SFOpporunityId-456
businessNamestring

Filter by business name.

createdAtStartstring, (date-time)

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

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

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

Example:createdAtEnd=2024-12-26T00:00:00.000Z
updatedAtStartstring, (date-time)

Return evidence updated on or after this ISO 8601 date-time (inclusive).

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

Return evidence updated on or before this ISO 8601 date-time (inclusive).

Example:updatedAtEnd=2024-12-26T00:00:00.000Z
statusArray of strings

Filter by lifecycle state. Accepts a comma-separated list (or repeated values) of evidence states plus the special value unassigned, which matches evidence not linked to any idea.

Items Enum:"inReview""validated""declined""unassigned"
Example:status=inReview&status=unassigned
GET
/v2/evidences
curl -i -X GET \
  'https://api.bagel.ai/v2/evidences?page=1&pageSize=500&sortBy=createdAt&sortDir=asc&ids=5f8d0d55b54764421b7156c3%2C5f8d0d55b54764421b7156c4&componentId=string&ownerId=string&ideaId=string&orgId=string&origin=salesforce&originIds=SFOpporunityId-123%2CSFOpporunityId-456&businessName=string&createdAtStart=2024-12-01T00%3A00%3A00.000Z&createdAtEnd=2024-12-26T00%3A00%3A00.000Z&updatedAtStart=2024-12-01T00%3A00%3A00.000Z&updatedAtEnd=2024-12-26T00%3A00%3A00.000Z&status=inReview%2Cunassigned' \
  -H 'authorization: YOUR_API_KEY_HERE'

Responses

A paginated list of evidence

Bodyapplication/json
itemsArray of objects(ApiEvidence)
totalinteger

Total number of evidence 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": [
    { … },
    { … }
  ]
}