Getting Started

Learn how to make your first API call and integrate with the Revenue Orbit CRM platform.

Base URL

All API requests should be made to:

https://crm.revorbit.com/api

Authentication

The Revenue Orbit API uses JWT (JSON Web Token) authentication. To get started, you need to obtain a token by logging in with your credentials.

Step 1: Get Your Token

Send a POST request to the login endpoint with your email and password:

curl -X POST "https://crm.revorbit.com/api/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "password": "your-password"}'

On success, you will receive a JWT token in the response:

{
    "success": true,
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "user": {
        "id": 1,
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "you@example.com",
        "role": "admin"
    }
}

Step 2: Use Your Token

Include the token in the Authorization header of all subsequent requests:

Authorization: Bearer YOUR_JWT_TOKEN

Making Your First Request

List Contacts

Retrieve your first page of contacts:

curl -X GET "https://crm.revorbit.com/api/contacts?per_page=5" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Create a Contact

Create a new contact record:

curl -X POST "https://crm.revorbit.com/api/contacts" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "John", "last_name": "Doe", "email": "john@example.com"}'

Pagination

List endpoints support pagination with two query parameters:

ParameterDefaultDescription
page1Page number to retrieve
per_page25Number of results per page (max 100)

Paginated responses include metadata fields: current_page, last_page, per_page, and total.

Filtering and Sorting

Most list endpoints support filtering and sorting via query parameters. Common filters include status, assigned_to, and search. Sorting is controlled via sort (field name) and order (asc or desc).

Error Handling

The API uses standard HTTP status codes. Errors return a JSON response with success: false and a descriptive message. Always check the success field in the response body to determine if the request was successful.

Next Steps