I'mBoardDocs
Getting Started

Pagination, Filtering & Sorting

Collection endpoints support cursor-based pagination, field sorting, and query filtering.

Collection endpoints support cursor-based pagination, field sorting, and query filtering.

Pagination

I'mBoard uses cursor-based pagination for stable, efficient paging through results. Cursors are opaque tokens — do not parse or construct them.

Query Parameters

ParameterTypeDefaultDescription
limitinteger25Items per page (1–100)
cursorstringOpaque cursor from a previous response

Response Meta

{
  "data": [ "..." ],
  "meta": {
    "nextCursor": "eyJ...",
    "hasMore": true
  }
}
  • nextCursor — pass as ?cursor= to fetch the next page; null when there are no more results
  • hasMorefalse when you have reached the last page

Example: Paginating Through Boards

# First page (10 items)
curl -s "https://app.imboard.ai/api/v1/boards?limit=10" \
  -H "Authorization: Bearer imb_pat_YOUR_TOKEN"

# Next page — pass the cursor
curl -s "https://app.imboard.ai/api/v1/boards?limit=10&cursor=eyJ..." \
  -H "Authorization: Bearer imb_pat_YOUR_TOKEN"

Keep fetching while hasMore is true. When hasMore is false and nextCursor is null, you have all results.

Sorting

ParameterTypeDefaultDescription
sortstringendpoint-specificField to sort by
orderstringdescSort direction: asc or desc

Sort Fields by Endpoint

EndpointDefault SortAllowed Sort Fields
GET /boardsupdatedAt desccreatedAt, updatedAt
GET /boards/:boardId/memberscreatedAt desccreatedAt
GET /boards/:boardId/meetingsstartTime descstartTime
GET /boards/:boardId/documentsupdatedAt descupdatedAt
GET /boards/:boardId/reportsupdatedAt descupdatedAt
GET /boards/:boardId/reports/:reportId/dashboardsupdatedAt descupdatedAt

Requesting a sort field that is not in the allowed list returns INVALID_QUERY_PARAMETER.

Filtering

Some collection endpoints accept additional query parameters for filtering results. Supported filters vary by endpoint.

Filters by Endpoint

EndpointFilterTypeDescription
GET /boards/:boardId/meetingsstatusstringFilter by meeting status
GET /boards/:boardId/meetingsstartAfterISO-8601Meetings starting after this time (exclusive)
GET /boards/:boardId/meetingsstartBeforeISO-8601Meetings starting before this time (exclusive)
GET /boards/:boardId/documentsmeetingIdstringFilter to documents linked to this meeting
GET /boards/:boardId/documentsdocumentTypestringFilter by document type
GET /boards/:boardId/reportsstatusstringFilter by report status (e.g. draft, published)
GET /boards/:boardId/reports/:reportId/dashboardsdashboardTypestringFilter by dashboard type (e.g. financial, hr, sales)

GET /boards and GET /boards/:boardId/members do not currently support filters.

Unknown Query Parameters

The API rejects unknown query parameters rather than silently ignoring them. This prevents typos from producing unexpected results.

On this page