/** * Help API Services Page * * User-friendly help documentation for the Services API. */ import React from 'react'; import { useTranslation } from 'react-i18next'; import { useNavigate } from 'react-router-dom'; import { ArrowLeft, Briefcase, DollarSign, Clock, Image, Code, HelpCircle, } from 'lucide-react'; const HelpApiServices: React.FC = () => { const { t } = useTranslation(); const navigate = useNavigate(); return (
{/* Back Button */} {/* Header */}

Services API

Access your service catalog via API

{/* Overview Section */}

Overview

Access your service catalog via the public API to integrate scheduling capabilities into your own applications, websites, or mobile apps.

Required scope: services:read

Note: Services are read-only via the public API. Use the dashboard to create, update, or delete services.

{/* Endpoints Section */}

Endpoints

{/* List Services */}
GET /api/v1/services/

Returns all active services ordered by display_order.

{/* Get Service */}
GET /api/v1/services/{'{id}'}/

Returns detailed information for a specific service by UUID.

{/* Service Object Section */}

Service Object

Field Type Description
id UUID Unique identifier for the service
name string Service name (e.g., "Haircut", "Oil Change")
description string | null Optional detailed description of the service
duration
integer Duration in minutes (e.g., 30, 60, 90)
price
decimal | null Price in dollars (null for variable pricing)
photos
array Array of photo URLs for the service
is_active boolean Whether the service is currently active
{/* Example Response Section */}

Example Response

{`{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Haircut",
  "description": "Professional haircut service",
  "duration": 30,
  "price": "45.00",
  "photos": [
    "https://smoothschedule.nyc3.digitaloceanspaces.com/..."
  ],
  "is_active": true
}`}
          
{/* Code Examples Section */}

Code Examples

{/* List Services */}

List All Services

{`curl -X GET "https://yourbusiness.smoothschedule.com/api/v1/services/" \\
  -H "Authorization: Bearer YOUR_API_KEY" \\
  -H "Content-Type: application/json"`}
            
{/* Get Service */}

Get Specific Service

{`curl -X GET "https://yourbusiness.smoothschedule.com/api/v1/services/550e8400-e29b-41d4-a716-446655440000/" \\
  -H "Authorization: Bearer YOUR_API_KEY" \\
  -H "Content-Type: application/json"`}
            
{/* Need More Help */}

Need More Help?

Our support team is ready to help with any questions about the Services API.

); }; export default HelpApiServices;