Authentication
API key authentication, permissions, and rate limits.
Authentication
API Keys
- Go to Settings → API Keys
- Click Create API Key
- Choose read-only or read-write permissions
- Copy your key and Organization ID
# .env
BOARBS_API_KEY=sk_...
BOARBS_ORG_ID=org_...Usage
curl -H "Authorization: Bearer $BOARBS_API_KEY" \
"https://app.boarbs.com/api/boards?organizationId=$BOARBS_ORG_ID"Permissions
| Level | Allowed |
|---|---|
| Read-only | GET requests only |
| Read-write | All methods (GET, POST, PATCH, DELETE) |
Write operations with a read-only key return 403 Forbidden.
Rate Limits
| Auth Type | Limit | Scope |
|---|---|---|
| API Key | 100 req/min | Per key |
| Session | 1,000 req/min | Per user |
| Unauthenticated | 20 req/min | Per IP |
Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
429 Too Many Requests when exceeded.
Errors
| Code | Meaning |
|---|---|
401 | Missing or invalid API key |
403 | Insufficient permissions or wrong organization |
429 | Rate limit exceeded |