DocsPrivacyTerms

API Overview

The Branded Barber API is a RESTful, multi-tenant backend service that powers your barbershop website. All endpoints are tenant-scoped and return JSON responses.

Base URL

All API requests should be made to your API base URL:

https://your-api-domain.com/api/v1
Note: Replace your-api-domain.com with your actual API deployment URL (e.g., Railway, Vercel, or your own server).

API Features

Multi-Tenant

All endpoints are scoped to a tenant ID, ensuring complete data isolation between barbershops.

RESTful Design

Standard HTTP methods (GET, POST, PUT, DELETE) with intuitive resource-based URLs.

Request Validation

All request payloads are validated using express-validator before processing.

Rate Limiting

Built-in rate limiting protects the API from abuse and ensures fair usage.

Error Handling

Consistent error responses with clear messages and appropriate HTTP status codes.

TypeScript

Fully typed API with shared types ensuring consistency across the platform.

Response Format

All API responses follow a consistent JSON structure:

// Success Response
{
  "success": true,
  "data": {
    // Response data here
  }
}

// Error Response
{
  "success": false,
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}

Available Resources

The API provides endpoints for the following resources:

Content

Retrieve public content configuration including hero sections, services, contact info, and branding.

Gallery

Manage gallery items (images/videos) with filtering by platform, pagination, and metadata.

Barbers

Manage barber profiles, including names, titles, and availability information.

Services

Service catalog management with pricing, duration, and descriptions.

Hours

Business hours configuration for different days of the week.

Contact

Contact information including address, phone, email, and social media links.

Next Steps

Explore the API documentation to learn more:

View API Endpoints →