Overview

461
Total Endpoints
REST
Architecture
JSON
Format
v1
Current Version

Base URL

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

Version: /api/v1/...

API Statistics

  • Public Endpoints: 15 endpoints (no authentication required)
  • Client/Store Endpoints: 39 endpoints (public store, mixed auth)
  • Admin Endpoints: 403 endpoints (authentication required)
  • Webhook Endpoints: 4 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. All 461 endpoints are documented below.

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.

Public Endpoints

10 endpoints
post /api/approve-pool-order Public
post /api/cancel-reset-password Public
post /api/forgot-password Public
get /api/health Public
post /api/login Public
post /api/register Public
post /api/reset-password Public
post /api/sms-call/save-received-sms Public
post /api/sms-call/save-sent-sms Public
get /api/workstations/activeToLogin Public

Public Admin Routes

5 endpoints
get /api/admin/header-data Public
get /api/admin/person/media/{personId} Public
get /api/admin/quickbooks/connect Public
post /api/admin/quickbooks/connect Public
get /api/admin/work-order/files/{workOrderId} Public

Home & Gallery

3 endpoints
get /api/gallery Auth
get /api/gallery/images/{image} Auth
get /api/home Auth

Shop & Cart

9 endpoints
post /api/cart/add Auth
post /api/cart/clear Auth
post /api/cart/decrease-quantity Auth
post /api/cart/increase-quantity Auth
delete /api/cart/remove/{cartId}/item/{itemId} Auth
get /api/cart/{cartId} Auth
get /api/shop Auth
get /api/shop/product/images/image/{image} Auth
get /api/shop/product/{name} Auth

Orders, Quotes & Proposals

19 endpoints
get /api/client/exchange-fb-token/{shortToken} Auth
post /api/client/facebook/save-page-token Auth
get /api/client/refresh-fb-token/{facebookId} Auth
post /api/confirm-advances Auth
post /api/confirm-proposal Auth
post /api/confirm-quote/{id} Auth
get /api/contact-name Auth
post /api/contact-susbscription Auth
get /api/facebook/webhook Auth
post /api/facebook/webhook Auth
get /api/footer-worstations Auth
post /api/invoice-pay-token Auth
post /api/invoice-token Auth
get /api/manager-contact/{lastname} Auth
post /api/order-token Auth
post /api/process-order/{id} Auth
post /api/quote Auth
post /api/register-back-contact Auth
post /api/save-contact Auth

Content & CMS

8 endpoints
get /api/about-us Auth
get /api/blogs Auth
get /api/blogs/{id}/image Auth
get /api/blogs/{title} Auth
get /api/faqs Auth
get /api/legal-terms Auth
get /api/portfolio Auth
get /api/portfolio/work/{title} Auth

Core & Dashboard

1 endpoint
get /api/dashboard Auth

Users & Contacts

40 endpoints
post /api/admin Auth
get /api/admin/email-templates Auth
get /api/admin/email-templates/{emailTemplate} Auth
put /api/admin/email-templates/{emailTemplate} Auth
get /api/admin/email-templates/{emailTemplate}/users Auth
put /api/admin/email-templates/{emailTemplate}/users Auth
put /api/admin/email-templates/{emailTemplate}/users/{personId} Auth
get /api/admin/info/{id} Auth
delete /api/admin/{id} Auth
get /api/admin/{id} Auth
put /api/admin/{id} Auth
get /api/admins Auth
get /api/admins/active-to-tasks/{id} Auth
get /api/admins/active/{id} Auth
post /api/assign-user-to-work-order Auth
get /api/chat/users Auth
get /api/chat/workstation/{workstationId}/users Auth
post /api/client Auth
delete /api/client/{id} Auth
get /api/client/{id} Auth
put /api/client/{id} Auth
get /api/companies-contact Auth
get /api/companies-contact Auth
post /api/companies-contact Auth
get /api/contacts Auth
get /api/contacts-new-order Auth
get /api/contacts/active Auth
get /api/contacts/active-us-booths-connect Auth
get /api/get-admins-to-assign-work-order Auth
get /api/get-admins-to-assign/{id} Auth
post /api/note/contact Auth
put /api/note/contact/{id} Auth
get /api/notes/contact Auth
get /api/orders/admin Auth
get /api/orders/contact Auth
get /api/sms-call/contacts/{number} Auth
get /api/user-profile Auth
get /api/user/info/{id} Auth
put /api/user/sidebar-width Auth
delete /api/user/{id} Auth

Products & Catalog

43 endpoints
get /api/active-colors/{id} Auth
get /api/all-custom-products Auth
post /api/category Auth
delete /api/category/{id} Auth
post /api/category/{id} Auth
post /api/color Auth
delete /api/color/{id} Auth
post /api/color/{id} Auth
get /api/colors Auth
post /api/custom-product Auth
delete /api/custom-product/{id} Auth
get /api/custom-product/{id} Auth
post /api/custom-product/{id} Auth
get /api/custom-products Auth
get /api/get-standard-products Auth
post /api/manage-materials-categories-assigned Auth
post /api/material-warehouse-in Auth
post /api/material-warehouse-out Auth
get /api/material/{id} Auth
get /api/materials-categories Auth
get /api/materials-categories-assigned/{id} Auth
delete /api/product/image/{id} Auth
post /api/product/images Auth
get /api/product/images/{id} Auth
get /api/production-calendar Auth
post /api/production-calendar Auth
put /api/production-calendar/update-date/{id} Auth
delete /api/production-calendar/{id} Auth
put /api/production-calendar/{id} Auth
post /api/save-product-to-order Auth
post /api/standard-product Auth
delete /api/standard-product/{id} Auth
get /api/standard-product/{id} Auth
post /api/standard-product/{id} Auth
get /api/standard-products Auth
post /api/store-product Auth
delete /api/store-product/{id} Auth
get /api/store-product/{id} Auth
post /api/store-product/{id} Auth
get /api/store-products Auth
put /api/update-category Auth
post /api/update-image-material Auth
put /api/update-lead-category Auth

Orders & Invoices

92 endpoints
post /api/add-standard-temp-order-item Auth
post /api/add-temp-invoice-item Auth
post /api/add-temp-order-item Auth
get /api/archived-orders Auth
post /api/assign-factory-to-order Auth
delete /api/cancel-temp-order-detail Auth
post /api/change-pool-order-status Auth
put /api/confirm-proposal Auth
delete /api/delete-order-file/{id} Auth
post /api/delete-proposal Auth
delete /api/delete-temp-invoice-item/{id} Auth
delete /api/delete-temp-order-item/{id} Auth
post /api/duplicate-order Auth
post /api/edit-temp-invoice-item Auth
post /api/edit-temp-order-item Auth
post /api/generate-invoice-pdf/{id} Auth
get /api/generate-order-pdf/{id} Auth
post /api/generate-pdf-quote/{id} Auth
get /api/get-invoice/{id} Auth
get /api/get-order-assigned/{id} Auth
get /api/get-order-files/{id} Auth
get /api/get-temp-invoice-items Auth
get /api/get-temp-order-items Auth
get /api/get-work-orders-completed/{id} Auth
post /api/invoice/process-partial-payment Auth
delete /api/invoice/{id} Auth
get /api/invoices Auth
post /api/manage-assigned-order Auth
post /api/order-comment Auth
delete /api/order-comment-file/{id} Auth
post /api/order-comment/{id} Auth
get /api/order-comments/{id} Auth
put /api/order/deadline/{orderId} Auth
delete /api/order/{id} Auth
get /api/order/{id} Auth
post /api/order/{id} Auth
get /api/orders Auth
get /api/orders/active/{id} Auth
post /api/orders/bulk-delete Auth
post /api/person-work-order/{id} Auth
post /api/pool-order Auth
delete /api/pool-order/{id} Auth
put /api/pool-order/{id} Auth
get /api/pool-order/{token} Auth
get /api/pool-orders Auth
post /api/process-invoice Auth
post /api/process-order Auth
post /api/proposals Auth
get /api/proposals/{id} Auth
delete /api/quickbooks/delete-invoice Auth
get /api/quickbooks/invoices Auth
get /api/quickbooks/invoices/payments/{id} Auth
post /api/quickbooks/invoices/{id}/sync-payments Auth
get /api/quickbooks/invoices/{invoiceId} Auth
post /api/quickbooks/invoices/{invoiceId}/send Auth
post /api/quickbooks/update-invoice-status Auth
delete /api/quote-request/{id} Auth
get /api/quote-request/{id} Auth
get /api/quote-requests Auth
delete /api/remove-invoice-expense/{id} Auth
post /api/save-add-temp-order-item Auth
post /api/save-order-files Auth
post /api/save-proposal Auth
get /api/send-email/{orderId}/{nameFile} Auth
post /api/send-invoice Auth
get /api/send-invoice-pdf/{id} Auth
post /api/send-invoice-update-design Auth
post /api/send-order-advance/{id} Auth
get /api/send-pdf-quote/{id} Auth
post /api/send-proposal Auth
post /api/send-quote Auth
post /api/take-pool-order Auth
post /api/take-work-order Auth
post /api/update-assign-pool-order Auth
post /api/update-assign-work-order Auth
post /api/update-invoice-status Auth
post /api/update-order Auth
post /api/update-order-status Auth
post /api/update-status-work-order Auth
post /api/work-order Auth
post /api/work-order-note Auth
delete /api/work-order-note/{id} Auth
put /api/work-order-note/{id} Auth
get /api/work-order-notes Auth
post /api/work-order-team/set-leader Auth
get /api/work-order-team/{workOrderId} Auth
post /api/work-order/files Auth
delete /api/work-order/files/{id} Auth
delete /api/work-order/{id} Auth
get /api/work-order/{id} Auth
put /api/work-order/{id} Auth
get /api/work-orders Auth

Inventory & Materials

24 endpoints
get /api/dynamic-inventory Auth
post /api/dynamic-inventory Auth
delete /api/dynamic-inventory/{id} Auth
get /api/dynamic-inventory/{id} Auth
post /api/dynamic-inventory/{id} Auth
post /api/expense Auth
delete /api/expense/{id} Auth
post /api/expense/{id} Auth
get /api/expenses Auth
post /api/fix-expense Auth
delete /api/fix-expense/{id} Auth
get /api/fix-expense/{id} Auth
post /api/fix-expense/{id} Auth
get /api/fix-expenses Auth
get /api/fix-inventory Auth
post /api/fix-inventory Auth
delete /api/fix-inventory/{id} Auth
get /api/fix-inventory/{id} Auth
post /api/fix-inventory/{id} Auth
get /api/foam-inventory Auth
post /api/foam-inventory Auth
delete /api/foam-inventory/{id} Auth
get /api/foam-inventory/{id} Auth
post /api/foam-inventory/{id} Auth

Chat & Notifications

34 endpoints
get /api/all-notifications Auth
delete /api/calls/hang-up/{callSid} Auth
post /api/calls/make Auth
get /api/calls/status/{callSid} Auth
post /api/calls/token Auth
get /api/chat/get-messages/{id} Auth
get /api/chat/group/{groupId}/messages Auth
get /api/chat/groups Auth
post /api/chat/groups Auth
delete /api/chat/groups/{groupId}/members/{personId} Auth
put /api/chat/groups/{groupId}/members/{personId}/role Auth
delete /api/chat/groups/{id} Auth
get /api/chat/groups/{id} Auth
put /api/chat/groups/{id} Auth
get /api/chat/groups/{id}/members Auth
post /api/chat/groups/{id}/members Auth
post /api/chat/groups/{id}/toggle-mute Auth
delete /api/chat/message/{id} Auth
put /api/chat/message/{id}/edit Auth
post /api/chat/send-message Auth
get /api/chat/workstations-groups Auth
post /api/ia-chat-async Auth
post /api/notification/mark-as-read Auth
get /api/notifications Auth
post /api/notifications Auth
post /api/notifications/mark-all-as-read Auth
get /api/notifications/unread-count Auth
delete /api/notifications/{notification} Auth
post /api/send-notification Auth
get /api/sms-call/all-messages-number/{number} Auth
post /api/sms-call/available-numbers Auth
post /api/sms-call/get-new-numbers Auth
get /api/sms-call/numbers Auth
post /api/sms-call/send-message Auth

Files & Media

24 endpoints
delete /api/delete-check-in-out-file/{id} Auth
post /api/delete-files Auth
delete /api/delete-general-file/{id} Auth
delete /api/file-manager/{id} Auth
get /api/files-manager Auth
post /api/files-manager Auth
get /api/gallery Auth
post /api/gallery Auth
get /api/gallery/image/{image} Auth
delete /api/gallery/{id} Auth
get /api/get-check-in-out-files/{id} Auth
get /api/get-files-qirp/{id} Auth
post /api/person/media Auth
delete /api/person/media/{id} Auth
delete /api/portfolio/work/file/{id} Auth
get /api/profile Auth
post /api/save-check-in-out-files Auth
post /api/save-general-file Auth
get /api/slider-images Auth
post /api/slider-images Auth
delete /api/slider-images/{id} Auth
get /api/slider-images/{id} Auth
post /api/slider-images/{id} Auth
post /api/update-profile-img Auth

Calendar & Tasks

14 endpoints
post /api/break-check-in Auth
delete /api/check-in-out/{id} Auth
post /api/finish-check-in Auth
get /api/get-check-in Auth
post /api/new-check-in-out Auth
post /api/restart-check-in Auth
post /api/start-check-in Auth
post /api/task Auth
delete /api/task/{id} Auth
get /api/task/{id} Auth
put /api/task/{id} Auth
put /api/task/{id}/complete Auth
get /api/tasks Auth
post /api/update-check-in-out/{id} Auth

Integrations

12 endpoints
get /api/integrations Auth
get /api/integrations/ghl/companies Auth
get /api/integrations/ghl/company-id Auth
post /api/quickbooks/auth-url Auth
delete /api/quickbooks/disconnect Auth
get /api/quickbooks/payments/{paymentId} Auth
get /api/twilio/available-numbers Auth
get /api/twilio/messages/twilio-number/{number} Auth
post /api/twilio/new-number Auth
get /api/twilio/numbers Auth
post /api/twilio/send-message Auth
get /api/validate-integrations Auth

CMS & Content

25 endpoints
get /api/about-us Auth
post /api/about-us Auth
post /api/about-us/{id} Auth
post /api/blog Auth
get /api/blog/image/{id} Auth
delete /api/blog/{id} Auth
get /api/blog/{id} Auth
post /api/blog/{id} Auth
get /api/blogs Auth
post /api/faq Auth
delete /api/faq/{id} Auth
post /api/faq/{id} Auth
get /api/faqs Auth
post /api/legal-term Auth
post /api/legal-term/{id} Auth
get /api/legal-terms Auth
get /api/portfolio Auth
post /api/portfolio/work Auth
delete /api/portfolio/work/{id} Auth
post /api/portfolio/work/{id} Auth
post /api/testimonial Auth
delete /api/testimonial/{id} Auth
post /api/testimonial/{id} Auth
get /api/testimonials Auth
post /api/wikiStore Auth

Other Resources

94 endpoints
get /api/ Auth
get /api/categories Auth
get /api/categories/active/{workstationId}/{module} Auth
get /api/check-fb-session Auth
get /api/companies Auth
post /api/company Auth
post /api/company-location Auth
delete /api/company-location/{id} Auth
put /api/company-location/{id} Auth
get /api/company-locations Auth
get /api/company-numbers Auth
put /api/company/{id} Auth
post /api/create-bill Auth
delete /api/delete-stage/{id} Auth
delete /api/delete-subscription/{id} Auth
post /api/example/send-number Auth
get /api/folder-manager Auth
post /api/folder-manager Auth
delete /api/folder-manager/{id} Auth
get /api/folder-manager/{id} Auth
post /api/folder-manager/{id} Auth
get /api/generate-qr/{id} Auth
post /api/generate-receipt-pdf/{id} Auth
get /api/get-ordes-clock Auth
get /api/get-pdf-receipt/{id} Auth
get /api/get-projects-manager/{id} Auth
get /api/get-response Auth
get /api/get-subscription/{id} Auth
get /api/get-work-ordes-clock Auth
get /api/get-worktations-factories Auth
get /api/lead-categories Auth
get /api/leads-center Auth
post /api/logout Auth
post /api/new-note Auth
post /api/new-subscription Auth
get /api/notes Auth
post /api/pay-plan-subscription Auth
post /api/pay-worked-hours Auth
get /api/payment-methods Auth
get /api/person-documents/{id} Auth
delete /api/person-payment/{personPayment} Auth
get /api/plan-subscriptions Auth
get /api/plans Auth
post /api/process-manual-payment Auth
get /api/proxy-texture Auth
post /api/register-device-token Auth
post /api/reports/send Auth
post /api/role Auth
delete /api/role/{id} Auth
post /api/role/{id} Auth
get /api/roles Auth
get /api/roles/active Auth
get /api/roles/all-permissions Auth
get /api/roles/module-permissions Auth
post /api/roles/permissions Auth
post /api/save-fb-session Auth
post /api/save-stage Auth
post /api/send-receipt Auth
get /api/sidebar-modules Auth
post /api/stop-clock Auth
post /api/terms-acceptance Auth
post /api/terms-acceptance/check/{personId} Auth
get /api/terms-acceptance/person/{personId} Auth
post /api/transaction Auth
delete /api/transaction/{id} Auth
post /api/transaction/{id} Auth
get /api/transactions Auth
put /api/update-note/{id} Auth
put /api/update-payment-worked-hours/{id} Auth
post /api/update-proyect-manager-assign Auth
put /api/update-source Auth
put /api/update-stage/{id} Auth
put /api/update-subscription/{id} Auth
post /api/update-to-waiting-approval Auth
post /api/uploads/3d-model Auth
post /api/vendor Auth
post /api/vendor-comment Auth
delete /api/vendor-comment/{id} Auth
put /api/vendor-comment/{id} Auth
delete /api/vendor/{id} Auth
get /api/vendor/{id} Auth
post /api/vendor/{id} Auth
get /api/vendor/{vendorId}/comments Auth
get /api/vendors Auth
get /api/vendors/active/{workstationId} Auth
post /api/workstation Auth
delete /api/workstation/{id} Auth
get /api/workstation/{id} Auth
post /api/workstation/{id} Auth
get /api/workstations Auth
get /api/workstations/active Auth
delete /api/{id}/delete Auth
get /api/{id}/show Auth
put /api/{id}/update Auth

External Integrations

4 endpoints
post /api/ghl/webhook Webhook
post /api/ghl/webhook/opportunity Webhook
post /api/twilio/get-message-received Webhook
post /api/webhooks/quickbooks/payments Webhook