API Reference
API Reference
Interactive API reference generated from the I'mBoard OpenAPI 3.1 specification.
The API reference is generated from the OpenAPI 3.1 specification.
You can also download the raw spec:
https://app.imboard.ai/api/v1
All endpoints require a Bearer token:
Authorization: Bearer imb_pat_...
See Authentication for details.
| Method | Path | Description |
|---|
GET | /api/v1/me | Get current user profile |
| Method | Path | Description |
|---|
GET | /api/v1/boards | List boards |
GET | /api/v1/boards/:boardId | Get a board |
| Method | Path | Description |
|---|
GET | /api/v1/boards/:boardId/members | List board members |
GET | /api/v1/boards/:boardId/members/:memberId | Get a board member |
| Method | Path | Description |
|---|
GET | /api/invite/:boardId/invites | List pending invites for a board (legacy) |
GET | /api/invite/sent | List invites sent by the caller (legacy) |
GET | /api/invite/all-boards | List pending invites grouped by board (legacy) |
POST | /api/invite/:boardId/test | Send a test invite email (legacy) |
POST | /api/invite/:boardId | Create (or dedupe onto) an invite (legacy) |
POST | /api/invite/:boardInviteId/send-email | Send/resend the invite email (legacy) |
GET | /api/invite/:boardId/code | Get or create the board's invite code (legacy) |
PUT | /api/invite/accept/:boardInviteId | Accept an invite (legacy) |
PUT | /api/invite/join/:inviteCode | Accept an invite via invite code (legacy) |
GET | /api/v1/invite/status/:inviteCode | Check whether an invite code is pending (public) |
PUT | /api/invite/decline/:boardInviteId | Decline an invite (legacy) |
PUT | /api/invite/retract/:boardInviteId | Retract a sent invite (legacy) |
| Method | Path | Description |
|---|
GET | /api/v1/boards/:boardId/meetings | List meetings |
GET | /api/v1/boards/:boardId/meetings/:meetingId | Get a meeting |
POST | /api/v1/boards/:boardId/meetings | Create a meeting |
PATCH | /api/v1/boards/:boardId/meetings/:meetingId | Update a meeting |
| Method | Path | Description |
|---|
POST | /api/v1/boards/:boardId/meetings/:meetingId/action-items | Create an action item |
GET | /api/action-items/my | List my action items across all boards (legacy) |
PATCH | /api/action-items/:actionItemId/status | Update an action item's status (legacy) |
GET | /api/board/:boardId/action-items | List a board's action items (legacy) |
PATCH | /api/board/:boardId/action-items/:actionItemId | Update a board-scoped action item's status (legacy) |
| Method | Path | Description |
|---|
GET | /api/v1/boards/:boardId/meetings/:meetingId/slots | List proposed slots |
POST | /api/v1/boards/:boardId/meetings/:meetingId/slots | Create a proposed slot |
PUT | /api/v1/boards/:boardId/meetings/:meetingId/slots/:slotId/vote | Vote on a slot |
DELETE | /api/v1/boards/:boardId/meetings/:meetingId/slots/:slotId | Delete a slot |
POST | /api/v1/boards/:boardId/meetings/:meetingId/slots/:slotId/confirm | Confirm slot as meeting time |
| Method | Path | Description |
|---|
GET | /api/v1/boards/:boardId/documents | List documents |
GET | /api/v1/boards/:boardId/documents/:documentId | Get a document |
| Method | Path | Description |
|---|
GET | /api/v1/boards/:boardId/reports | List reports |
GET | /api/v1/boards/:boardId/reports/:reportId | Get a report |
| Method | Path | Description |
|---|
GET | /api/v1/boards/:boardId/reports/:reportId/dashboards | List dashboards |
GET | /api/v1/boards/:boardId/reports/:reportId/dashboards/:dashboardId | Get a dashboard |
| Method | Path | Description |
|---|
GET | /api/auditlog/:boardId | Get the audit trail for a board (legacy, admin-only) |
| Method | Path | Description |
|---|
GET | /api/notification/ | List notifications (legacy) |
PUT | /api/notification/read/all | Mark all notifications as read (legacy) |
PUT | /api/notification/read/:notificationId | Mark a single notification as read (legacy) |
DELETE | /api/notification/:notificationId | Delete a notification (legacy) |
GET | /api/notification/preferences | Get notification preferences (legacy) |
PUT | /api/notification/preferences | Update a notification preference (legacy) |