API Reference

REST API

Getting Started Authorization Best Practices

MCP (AI Assistants)

MCP Overview MCP Authentication

General

Status Get Business Identity Get Business Details

Contacts

List Contacts

Jobs

List Jobs

Estimates

List Estimates

Invoices

List Invoices

Offerings

List Offerings

Equipment

List Equipment

Events

List Events

List Equipment

GET https://backend.localbusiness.pro/api/v1/equipment

Returns a paginated list of equipment for the authenticated business, sorted by creation date (newest first).

Header Parameters

X-Public-Key string required

Your business public key. Used to identify which business is making the request.

X-Timestamp string required

Current Unix timestamp in seconds. Requests older than 5 minutes are rejected.

X-Signature string required

HMAC-SHA256 signature of the signing string: {timestamp}\n{METHOD}\n{path}\n{body}, using your private key as the secret.

Query Parameters

page integer

Page number (1-indexed).

per_page integer

Items per page (max 100). Default: 25.

status string

Filter by equipment status (e.g., available, assigned, maintenance, retired).

category string

Filter by equipment category (e.g., Power Tools, Vehicles).

Responses

200 Paginated list of equipment.

{
  "equipment": [
    {
      "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "equipment_number": "EQ-00007",
      "name": "Pressure Washer 3000",
      "serial_number": "PW3K-2025-0042",
      "tracking_mode": "individual",
      "quantity": 1,
      "category": "Power Tools",
      "model": "PW-3000X",
      "manufacturer": "CleanForce",
      "status": "available",
      "purchase_date": "2025-06-15",
      "maintenance_interval_days": 90,
      "next_maintenance_date": "2026-04-15",
      "created_at": "2025-06-20T10:00:00.000000Z",
      "updated_at": "2026-01-15T08:30:00.000000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_items": 23,
    "total_pages": 1
  }
}

401 Missing credentials, expired timestamp, or invalid signature.

{
  "error": "Invalid API credentials",
  "code": "INVALID_CREDENTIALS"
}

403 Business account exists but is not active.

{
  "error": "Business account is not active",
  "code": "ACCOUNT_INACTIVE"
}

429 Rate limit exceeded (60 requests/minute per key).

{
  "message": "Too Many Attempts."
}

Authentication — HMAC-SHA256

Every authenticated request requires three headers:

X-Public-KeyYour business public key

X-TimestampUnix timestamp (seconds)

X-SignatureHMAC-SHA256 of signing string

Signing string: {timestamp}\n{METHOD}\n{path}\n{body}

Request

GET https://backend.localbusiness.pro/api/v1/equipment

Rate Limits

With X-Public-Key: 60 req/min per key

Without: 10 req/min per IP

Code Examples

PUBLIC_KEY="pk_live_..."
PRIVATE_KEY="sk_live_..."
TIMESTAMP=$(date +%s)
PATH_URI="/api/v1/equipment?status=available"

SIGNATURE=$(printf '%s\n%s\n%s\n' "$TIMESTAMP" "GET" "$PATH_URI" \
  | openssl dgst -sha256 -hmac "$PRIVATE_KEY" | awk '{print $2}')

curl -H "X-Public-Key: $PUBLIC_KEY" \
     -H "X-Timestamp: $TIMESTAMP" \
     -H "X-Signature: $SIGNATURE" \
     "https://backend.localbusiness.pro$PATH_URI"

const crypto = require("crypto");

const publicKey = "pk_live_...";
const privateKey = "sk_live_...";
const timestamp = Math.floor(Date.now() / 1000).toString();
const method = "GET";
const path = "/api/v1/equipment?status=available";
const body = "";

const signingString = `${timestamp}\n${method}\n${path}\n${body}`;
const signature = crypto
  .createHmac("sha256", privateKey)
  .update(signingString)
  .digest("hex");

const response = await fetch("https://backend.localbusiness.pro/api/v1/equipment?status=available", {
  headers: {
    "X-Public-Key": publicKey,
    "X-Timestamp": timestamp,
    "X-Signature": signature,
  },
});

const data = await response.json();
console.log(data);

import hmac, hashlib, time, requests

public_key = "pk_live_..."
private_key = "sk_live_..."
timestamp = str(int(time.time()))
method = "GET"
path = "/api/v1/equipment?status=available"
body = ""

signing_string = f"{timestamp}\n{method}\n{path}\n{body}"
signature = hmac.new(
    private_key.encode(), signing_string.encode(), hashlib.sha256
).hexdigest()

response = requests.get(
    "https://backend.localbusiness.pro/api/v1/equipment?status=available",
    headers={
        "X-Public-Key": public_key,
        "X-Timestamp": timestamp,
        "X-Signature": signature,
    },
)
print(response.json())

<?php
$publicKey = 'pk_live_...';
$privateKey = 'sk_live_...';
$timestamp = time();
$method = 'GET';
$path = '/api/v1/equipment?status=available';
$body = '';

$signingString = $timestamp . "\n" . $method . "\n" . $path . "\n" . $body;
$signature = hash_hmac('sha256', $signingString, $privateKey);

$ch = curl_init('https://backend.localbusiness.pro/api/v1/equipment?status=available');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-Public-Key: $publicKey",
    "X-Timestamp: $timestamp",
    "X-Signature: $signature",
]);

$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));