Onbrix REST API
Build powerful integrations with our REST API. Manage contacts, deals, tasks, projects, surveys, territories, and more programmatically.
Make your first API call by listing contacts. Replace crm_your_api_key with a real key from Settings → Developer.
curl -H "X-API-Key: crm_your_api_key" https://app.onbrix.org/api/v1/contactsAuthentication
All API requests must include your API key in the X-API-Key header.
curl -H "X-API-Key: crm_your_api_key" https://app.onbrix.org/api/v1/contactsHow to get an API key:
- Log in to your Onbrix account at
https://app.onbrix.org - Navigate to Settings → Developer
- Click Create API Key
- Copy the key immediately — it is shown only once
API keys use a crm_ prefix and are stored as SHA-256 hashes. They cannot be retrieved after creation.
Rate Limits
The API allows 100 requests per minute per API key. Rate limit information is included in every response via headers:
| Header | Description |
|---|---|
| X-RateLimit-Limit | Maximum requests allowed per window (100) |
| X-RateLimit-Remaining | Requests remaining in the current window |
| X-RateLimit-Reset | Unix timestamp when the rate limit resets |
When the limit is exceeded the API responds with 429 Too Many Requests. Retry after the reset window.
Base URL
All API endpoints are relative to the following base URL:
https://app.onbrix.org/api/v1Response Format
All responses are JSON. List endpoints return paginated results with a pagination object. Single-record endpoints return the record directly in data.
List response
{
"success": true,
"data": [ ... ],
"pagination": {
"page": 1,
"page_size": 25,
"total": 142,
"total_pages": 6
}
}Single record response
{
"success": true,
"data": {
"id": "rec_abc123",
"first_name": "John",
"last_name": "Doe",
"created_at": "2026-03-15T10:30:00Z",
"updated_at": "2026-03-15T10:30:00Z"
}
}Error Codes
When an error occurs the API returns a JSON object with success: false and an error message.
{
"success": false,
"error": "The requested resource was not found."
}| Code | Status | Description |
|---|---|---|
| 400 | Bad Request | The request body is malformed or missing required fields. |
| 401 | Unauthorized | Missing or invalid API key. |
| 403 | Forbidden | The API key does not have permission to access this resource. |
| 404 | Not Found | The requested resource or module does not exist. |
| 429 | Too Many Requests | Rate limit exceeded. Wait and retry after the reset window. |
| 500 | Internal Server Error | An unexpected error occurred on the server. |