I'mBoard API Docs

A board represents a governance board in I'mBoard. Use these endpoints to list boards the authenticated user can access, or retrieve details for a specific board.

Endpoints

Method	Path	Description
`GET`	`/api/v1/boards`	List boards
`GET`	`/api/v1/boards/:boardId`	Get a board

Board Object

{
  "object": "board",
  "id": "60d5ec49f1a2c8b1f8e4e1a1",
  "name": "Acme Corp Board",
  "description": "Main governance board",
  "inviteCodeEnabled": true,
  "billingState": "PAID_ACTIVE",
  "myRole": "admin",
  "createdAt": "2025-01-10T08:00:00.000Z",
  "updatedAt": "2025-06-15T12:00:00.000Z"
}

Fields

Field	Type	Description
`object`	`"board"`	Always `"board"`
`id`	string	Opaque board ID
`name`	string	Board name
`description`	string \| null	Board description
`inviteCodeEnabled`	boolean	Whether the board's invite code is active
`billingState`	string	Current billing status (e.g. `TRIAL_ACTIVE`, `PAID_ACTIVE`, `PAST_DUE_GRACE`)
`myRole`	string \| null	The requesting user's role on this board (e.g. `admin`, `member`)
`createdAt`	string	ISO-8601 timestamp
`updatedAt`	string	ISO-8601 timestamp

Note

myRole is always included in board responses. It reflects the role of the authenticated user on the board, not an opt-in field.

List Boards

GET /api/v1/boards

Returns a paginated list of boards the authenticated user has access to.

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	25	Items per page (1–100)
`cursor`	string	—	Opaque cursor from a previous response
`sort`	string	`updatedAt`	Sort field: `updatedAt` or `createdAt`
`order`	string	`desc`	Sort direction: `asc` or `desc`

Example

curl -s "https://app.imboard.ai/api/v1/boards?limit=10" \
  -H "Authorization: Bearer imb_pat_YOUR_TOKEN" | jq

Get a Board

GET /api/v1/boards/:boardId

Returns the details of a single board. The authenticated user must be a member of the board.

Example

curl -s https://app.imboard.ai/api/v1/boards/60d5ec49f1a2c8b1f8e4e1a1 \
  -H "Authorization: Bearer imb_pat_YOUR_TOKEN" | jq

Boards

On this page