Revenue Orbit API Documentation

A RESTful API for integrating with the Revenue Orbit CRM platform. Manage contacts, companies, deals, leads, tasks, quotes, contracts, and more through a consistent, well-documented interface.

Base URL

https://crm.revorbit.com/api

Quick Links

Contacts

Manage contact records, notes, tasks, and related data.

Companies

Create and manage company records and associations.

Deals

Track opportunities through pipeline stages with risk scoring.

Leads

Capture and qualify inbound leads before conversion.

Tasks

Create tasks linked to contacts, deals, and companies.

Quotes

Generate quotes tied to deals and products with PDF export.

Contracts

Generate contracts from templates with merge tags.

Products

Manage the product catalog used in quotes and deals.

Key Concepts

Authentication

The API uses JWT (JSON Web Token) authentication. Include your token in the Authorization header of each request. See the Authentication page for details on obtaining and refreshing tokens.

Response Format

All responses return JSON. Successful responses include a success: true field:

{
    "success": true,
    "data": {
        "id": 1,
        "name": "..."
    },
    "message": "Record created successfully"
}

Error responses include a descriptive message:

{
    "success": false,
    "message": "Validation failed",
    "errors": {
        "email": "Email is required"
    }
}

Pagination

List endpoints return paginated results with metadata:

{
    "data": [
        {
            "id": 1,
            "name": "..."
        }
    ],
    "current_page": 1,
    "last_page": 5,
    "per_page": 25,
    "total": 112
}

Use the page and per_page query parameters to navigate results. Maximum per_page is 100.

HTTP Status Codes

Code	Description
`200`	Success
`201`	Created
`400`	Bad Request - Invalid input
`401`	Unauthorized - Invalid or missing token
`403`	Forbidden - Insufficient permissions
`404`	Not Found
`422`	Validation Error
`429`	Rate Limited
`500`	Internal Server Error

Rate Limiting

API requests are rate limited to ensure fair usage. If you exceed the limit, you will receive a 429 response. Implement exponential backoff in your integration to handle rate limits gracefully.