Skip to main content

API Reference

API Documentation

Complete REST API reference for the BlueRockTEL platform. Authenticate, manage resources, and integrate billing, CRM, and helpdesk into your workflows.

Get Started OpenAPI (YAML) OpenAPI (JSON) Postman collection Base URL: https://your-instance.bluerocktel.net/api/

Browse by section or use the sidebar on any page to navigate the full API reference. The complete reference is also published as an OpenAPI 3.0.3 document (JSON) for client generation, and as a Postman collection you can import directly.

Getting Started

Authentication

Authenticate with the BlueRockTEL API using Laravel Passport bearer tokens. Learn how to obtain and use API tokens.

Cookbook: Onboarding a New Customer

Step-by-step walkthrough for onboarding a new customer via the BlueRockTEL API: create a catalog family, add an item, register the customer, and build their billing file with licences, one-time charges, and recurring subscriptions.

Cookbook: Opening a Ticket from a Monitoring System

Step-by-step guide for automatically creating a support ticket from a monitoring alert: identify the customer from their 3CX PBX host, look up the right technical contact, and open the ticket — all via the BlueRockTEL API.

Core Resources

Customers

Manage customer records, search by name or account number, and query consumption data via the BlueRockTEL API.

Prospects

Manage sales prospects with auto-generated account numbers, full-text search, and prospect-to-customer conversion.

Establishments

Manage legal establishments (branches, subsidiaries) attached to a customer or prospect, each with its own registration number and address.

Contacts

Create and manage polymorphic contacts belonging to customers or prospects, with phone number lookup for call center integrations.

Organisations and Brands

Retrieve and update top-level tenant organisations and manage brand settings including logos and invoice images.

Users and Teams

Manage user accounts with role-based filtering, team assignments, and admin impersonation capabilities.

Billing & Finance

Invoices

Access final, preprod, and proforma invoices. Download PDF content and publish proforma invoices through the API.

Sales (Proforma Lines and Credits)

Manage proforma sales lines with automatic price calculation from catalog items, including credit applications.

Payment Plans

Create and manage polymorphic payment plans with automatic IBAN mandate generation and audit history.

Bank Details and GoCardless Mandates

Manage customer bank details and GoCardless direct debit mandates for automated payment collection.

Catalog

Catalog

Manage your product and service catalog including items, families, subfamilies, and bundles through the BlueRockTEL API.

CRM & Sales

Customer Files

Manage sales and billing dossiers with initial charges, recurring subscriptions, and licence line items.

Customer Services

List available services, view customer assignments, and sync service sets for individual customers.

Quotes & Documents

Generate, send, and electronically sign commercial documents including quotes, proformas, and contracts.

Information Collections

Manage onboarding forms for technical data collection including PBX configuration, with customer-facing token access.

Communication

Phone Calls

Log and manage phone interactions with automatic note creation, ticket activity tracking, and call status management.

Incoming Mails

Process incoming email messages, convert them to support tickets, and handle Mailgun webhook delivery events.

Notes

Attach polymorphic notes to any entity with automatic user attribution and timestamp management.

Documents

Upload, manage, and download polymorphic file attachments stored on OVH Swift object storage.

Communication

Mass email newsletters, campaigns, and customer satisfaction surveys with branching logic and reply tracking.

Infrastructure

Hosts and Infrastructure

Manage server inventory with customer filtering, software assignments, network interfaces, and reference data for infrastructure management.

PBX (3CX)

Manage 3CX phone system integrations including hosts, origins, call records, call logs, and audit trails.

Support

Incidents

Access public platform incident notices with status updates for real-time outage and degradation monitoring.

Tasks

List active tasks assigned to the authenticated user for action tracking and follow-up management.

Tickets

Full REST API for ticket lifecycle management, replies, time tracking, support contracts, teams, and analytics.

System

Utilities and Helpers

Access helper endpoints for version checks, reference data, string formatting, quick search, and system configuration.

HR & People

Recruitment

Manage candidates, job openings, interviews, contracts, and employer details for internal HR and staffing use cases.

Training

Learning management system (LMS) covering courses, programs, lessons, materials, quizzes, and student enrollment management.