Blox API Documentation

Complete guide to integrating with the Blox API

Getting Started

The Blox API provides programmatic access to all Blox platform features. Get started in minutes.

Base URL

https://api.blox.api/api
  1. Create an account or sign in
  2. Create an application
  3. Generate an API key
  4. Start making API calls!

Authentication

All API requests require authentication using an API key.

API Key Format

blox_live_xxxxxxxxxxxxxxxxxxxxxxxx # Production keys
blox_test_xxxxxxxxxxxxxxxxxxxxxxxx # Sandbox keys

Using Your API Key

Include your API key in requests using one of these methods:

Header Method (Recommended):

X-Blox-Api-Key: blox_live_xxxxxxxxxxxxxxxxxxxxxxxx

Bearer Token Method:

Authorization: Bearer blox_live_xxxxxxxxxxxxxxxxxxxxxxxx

Available Modules

Blox API provides access to multiple business modules:

Payroll

Manage employee salaries, payslips, overtime calculations, and tax deductions. Automate payroll processing with support for multiple pay periods, allowances, and statutory deductions.

Phase 1

Invoice

Create and manage invoices, estimates, and payment tracking. Support for recurring billing, payment reminders, and multiple payment gateways integration.

Phase 1

Purchase

Manage vendors, purchase orders, and inventory tracking. Streamline procurement processes with approval workflows and inventory management.

Phase 1

Project

Organize projects with tasks, subtasks, and milestones. Track time, manage resources, and monitor project progress with comprehensive project management tools.

Phase 1

Performance

Set and track OKRs, manage employee goals, conduct performance reviews, and schedule check-ins. Align team objectives with organizational goals.

Phase 1

Recruit

Post job openings, manage applications, schedule interviews, and track the hiring pipeline. Streamline recruitment from job posting to onboarding.

Phase 2

CRM

Manage leads, clients, deals, and sales pipelines. Track customer interactions, automate follow-ups, and analyze sales performance.

Phase 2

Support

Handle customer support tickets across multiple channels. Manage ticket assignments, track response times, and maintain support history.

Phase 2

Asset

Track company assets, manage assignments, and monitor asset lifecycle. Keep records of asset locations, maintenance, and depreciation.

Phase 2

Employee

Manage employee profiles, track attendance, handle leave requests, and maintain employee records. Comprehensive HR management system.

Phase 2

Biolinks

Create customizable link-in-bio pages. Build branded landing pages with multiple links, social media integration, and analytics tracking.

Phase 3

Webhook

Subscribe to real-time events and receive webhook notifications. Monitor delivery logs, retry failed deliveries, and manage webhook endpoints.

Phase 3

Zoom

Schedule and manage Zoom meetings directly from your application. Integrate video conferencing into your workflows with automatic meeting creation.

Phase 3

QR Code

Generate QR codes for various use cases. Create dynamic QR codes, track scans, and customize QR code appearance and data.

Phase 3

Letter

Generate HR letters and documents using customizable templates. Create offer letters, appointment letters, and other HR documents programmatically.

Phase 3

SMS

Send SMS messages through integrated gateway providers. Manage SMS campaigns, track delivery status, and handle two-way messaging.

Phase 3

E-Invoice

Generate electronic invoices in XML format compliant with tax regulations. Export invoices for e-invoicing systems and tax compliance.

Phase 3

Affiliate

Manage referral and affiliate programs. Track referrals, calculate commissions, and manage affiliate payouts with automated tracking.

Phase 3

Cybersecurity

Protect your application with IP and email blacklisting. Block malicious IPs, filter spam emails, and enhance security with threat detection.

Phase 3

Roadmap

Visualize project timelines and roadmaps. Create interactive timelines, track milestones, and share project roadmaps with stakeholders.

Phase 3

Code Examples

cURL Example

curl -X GET https://api.blox.api/api/v1/me \
  -H "X-Blox-Api-Key: blox_live_xxxxxxxxxxxxxxxxxxxxxxxx"

JavaScript Example

fetch('https://api.blox.api/api/v1/me', {
  headers: {
    'X-Blox-Api-Key': 'blox_live_xxxxxxxxxxxxxxxxxxxxxxxx'
  }
})
.then(response => response.json())
.then(data => console.log(data));

PHP Example

$ch = curl_init('https://api.blox.api/api/v1/me');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-Blox-Api-Key: blox_live_xxxxxxxxxxxxxxxxxxxxxxxx'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

Ready to get started?

Create your account and start building with the Blox API

Sign Up Free