Skip to main content

REST API Quick Start Guide

98 viewsUpdated March 10, 2026By Onbrix Team
apirestdeveloperauthentication

REST API Quick Start

Onbrix provides a REST API for integrating with external applications.

Getting Your API Key

  • Go to Settings > Developer
  • Click Create API Key
  • Give it a name and select module permissions
  • Copy the API key — it's shown only once
  • Important: Store your API key securely. It starts with crm_ and is stored as a SHA-256 hash in our database (never in plain text).

    Base URL

    All API endpoints are under:

    https://app.onbrix.org/api/v1
    

    Authentication

    Include your API key in the X-API-Key header:

    curl -H "X-API-Key: crm_your_key_here" \
    

    https://app.onbrix.org/api/v1/contacts

    Common Endpoints

    List Records
    GET /api/v1/{module}?page=1&page_size=25
    
    Get Single Record
    GET /api/v1/{module}/{id}
    
    Create Record
    POST /api/v1/{module}
    

    Content-Type: application/json

    {"first_name": "Jane", "email": "jane@example.com"}

    Update Record
    PATCH /api/v1/{module}/{id}
    

    Content-Type: application/json

    {"phone": "+1234567890"}

    Delete Record
    DELETE /api/v1/{module}/{id}
    

    Rate Limits

  • 100 requests per minute per API key
  • Response headers include: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
  • If you exceed the limit, you'll receive a 429 status code
  • Error Handling

    The API returns standard HTTP status codes:

  • 200: Success
  • 201: Created
  • 400: Bad request (invalid data)
  • 401: Unauthorized (invalid API key)
  • 404: Record not found
  • 429: Rate limit exceeded
  • 500: Server error