Getting Started
Quickstart
Get your first successful API call in under 2 minutes.
Get your first successful API call in under 2 minutes.
Prerequisites
- An I'mBoard account with at least one board
curland optionallyjqinstalled
1. Create a Token
- Open I'mBoard and navigate to Account > API Access
- Click Create Token
- Give it a name (e.g., "my-script") and choose an expiry
- Copy the token — it starts with
imb_pat_and is only shown once
2. Set Environment Variables
Store your token and the API base URL as environment variables so you don't paste secrets into every command:
export IMBOARD_API_BASE_URL=https://app.imboard.ai
export IMBOARD_API_TOKEN=imb_pat_YOUR_TOKEN_HERETip
To avoid storing the token in your shell history, use read -s IMBOARD_API_TOKEN for interactive sessions or load it from a .env file.
3. Verify Your Identity
Make a GET /api/v1/me call to confirm your token works:
curl -s "$IMBOARD_API_BASE_URL/api/v1/me" \
-H "Authorization: Bearer $IMBOARD_API_TOKEN" | jqExpected response:
{
"data": {
"object": "user",
"id": "abc123",
"email": "[email protected]",
"firstName": "Your",
"lastName": "Name",
"fullName": "Your Name",
"avatarUrl": null,
"timezone": "America/New_York",
"language": "en",
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2026-03-01T14:22:00.000Z"
}
}If you see your user info, authentication is working.
4. List Your Boards
curl -s "$IMBOARD_API_BASE_URL/api/v1/boards" \
-H "Authorization: Bearer $IMBOARD_API_TOKEN" | jqExpected response:
{
"data": [
{
"object": "board",
"id": "def456",
"name": "Q1 Board Meeting",
"description": "Quarterly review board",
"inviteCodeEnabled": true,
"billingState": "PAID_ACTIVE",
"myRole": "owner",
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2026-03-15T11:45:00.000Z"
}
],
"meta": {
"nextCursor": null,
"hasMore": false
}
}Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
401 UNAUTHENTICATED | Missing or malformed header | Check that you included -H "Authorization: Bearer ..." |
401 INVALID_API_TOKEN | Token is expired, revoked, or mistyped | Create a new token in Account > API Access |
429 RATE_LIMITED | Too many requests | Wait for the Retry-After period and retry |
| Connection refused | Wrong base URL | Verify IMBOARD_API_BASE_URL is https://app.imboard.ai |
Next Steps
- Authentication — Token lifecycle, security, and error handling
- Conventions — Response envelopes, field naming, and ID format
- First API Call guide — Detailed walkthrough with more examples
- Claude Code & MCP guide — Use the API with AI agents