API Reference
BrainstormMSP API
Build powerful integrations with our REST API. Full documentation for authentication, endpoints, webhooks, and best practices.
Base URL
brainstormmsp.ai/api/v1
Authentication
OAuth 2.0 / JWT
Format
JSON
Encryption
TLS 1.3
Endpoints
BrainstormMSP uses OAuth 2.0 with JWT tokens for API authentication. All API requests must include a valid access token in the Authorization header.
POST
/api/v1/auth/tokencurl -X POST https://brainstormmsp.ai/api/v1/auth/token \
-H "Content-Type: application/json" \
-d '{
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"grant_type": "client_credentials"
}'Response
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "read write"
}Notes
- Tokens expire after 1 hour (3600 seconds)
- Store tokens securely and refresh before expiration
- Include the token in all requests: Authorization: Bearer {token}
- Never expose your client_secret in client-side code
Rate Limits
API usage limits and quotas
| Endpoint Type | Rate Limit | Burst |
|---|---|---|
| Authentication | 10 requests/minute | 20 |
| List endpoints (GET) | 100 requests/minute | 200 |
| Detail endpoints (GET) | 200 requests/minute | 400 |
| Write endpoints (POST/PUT) | 50 requests/minute | 100 |
| Report generation | 10 requests/hour | 20 |
| Bulk operations | 5 requests/minute | 10 |
Rate limits are enforced per API key. When exceeded, requests return 429 Too Many Requests with a Retry-After header indicating when to retry.
Error Codes
HTTP status codes and error handling
| Code | Name | Description |
|---|---|---|
| 400 | Bad Request | Invalid request parameters or body |
| 401 | Unauthorized | Missing or invalid authentication token |
| 403 | Forbidden | Token valid but lacks required permissions |
| 404 | Not Found | Requested resource does not exist |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error, please retry |
Ready to Build?
Get your API keys and start building powerful integrations today.