I'mBoardDocs
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
  • curl and optionally jq installed

1. Create a Token

  1. Open I'mBoard and navigate to Account > API Access
  2. Click Create Token
  3. Give it a name (e.g., "my-script") and choose an expiry
  4. 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_HERE

Tip

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" | jq

Expected 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" | jq

Expected 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

SymptomCauseFix
401 UNAUTHENTICATEDMissing or malformed headerCheck that you included -H "Authorization: Bearer ..."
401 INVALID_API_TOKENToken is expired, revoked, or mistypedCreate a new token in Account > API Access
429 RATE_LIMITEDToo many requestsWait for the Retry-After period and retry
Connection refusedWrong base URLVerify IMBOARD_API_BASE_URL is https://app.imboard.ai

Next Steps

On this page