Overview

—
Total Endpoints
REST
Architecture
JSON
Format
v1.3
Doc Version

Base URL

API Base: https://api.usbooths.com

Version: /api/v1/...

API Statistics

  • Public Endpoints: — endpoints (no authentication required)
  • Client Endpoints: — endpoints (throttle:client)
  • Admin Endpoints: — endpoints (auth:sanctum, throttle:admin)
  • Webhook Endpoints: — endpoints (external integrations)

Key Features

  • Laravel Sanctum Authentication (token-based)
  • Comprehensive rate limiting by endpoint type
  • API Versioning support
  • Webhook integrations (QuickBooks, Twilio, GoHighLevel)
  • Role-based permissions system
  • Real-time chat and push notifications
  • Complete production and work order management
  • Multi-type inventory tracking (Fix, Dynamic, Foam)
  • QuickBooks, Twilio, and GoHighLevel integration
  • Comprehensive order and invoice management
  • CMS capabilities for storefront content

Note: This is auto-generated documentation from Laravel route files. Endpoints are loaded from routes.js — edit that file to update the list.

Authentication

The API uses Laravel Sanctum for token-based authentication. Tokens are required for all admin endpoints and some client endpoints.

POST /api/login Public
Authenticate user and receive access token

Request Body

{ "email": "user@example.com", "password": "your_password" }

Response

{ "success": true, "token": "1|abcdef123456...", "user": { "id": 1, "name": "User Name", "email": "user@example.com", "role": "admin" } }

Using Authentication Tokens

Include the token in the Authorization header for all authenticated requests:

Authorization: Bearer 1|abcdef123456...

Token Management

  • Logout: POST /api/logout (revokes current token)
  • Get User: GET /api/user (returns authenticated user info)
  • Password Reset: POST /api/forgot-password and /api/reset-password

Rate Limits

Rate limits are enforced to ensure API stability and fair usage across all clients.

Limit Types

  • Public Endpoints: 60 requests/minute per IP address
  • Auth Endpoints: 10 requests/minute per IP (login/register only)
  • Admin Endpoints: 600 requests/minute per authenticated user
  • Client/Store Endpoints: 120 requests/minute per IP
  • Webhook Endpoints: 120 requests/minute per IP

Rate Limit Headers

All API responses include rate limit information in headers:

  • X-RateLimit-Limit — Maximum requests allowed
  • X-RateLimit-Remaining — Requests remaining in current window
  • Retry-After — Seconds until limit resets (when exceeded)

Exceeded Rate Limits

When rate limits are exceeded, the API returns HTTP 429 Too Many Requests. Wait for the time specified in Retry-After header before making additional requests.