API Reference

Comprehensive API documentation for integrating SyncHQ Pro with your applications

Getting Started

The SyncHQ Pro API allows you to integrate service management capabilities into your applications. Our REST API provides access to jobs, customers, technicians, scheduling, and more.

Base URL:

https://api.servicesynchq.com/v1

Authentication

All API requests require authentication using API keys. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Keep your API keys secure and never expose them in client-side code.

Core Endpoints

Jobs

GET/jobs- List all jobs

GET/jobs/:id- Get job details

POST/jobs- Create a new job

PUT/jobs/:id- Update a job

Customers

GET/customers- List all customers

GET/customers/:id- Get customer details

POST/customers- Create a new customer

Technicians

GET/technicians- List all technicians

GET/technicians/:id/schedule- Get technician schedule

Invoices

GET/invoices- List all invoices

POST/invoices- Create an invoice

Example Request

Here's an example of creating a new job:

POST https://api.servicesynchq.com/v1/jobs
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "cus_123",
  "technician_id": "tech_456",
  "title": "AC Repair",
  "description": "Air conditioning not cooling",
  "scheduled_date": "2026-01-25T10:00:00Z",
  "location": {
    "address": "123 Main St",
    "city": "Mumbai",
    "state": "Maharashtra",
    "postal_code": "400001"
  }
}

Webhooks

Subscribe to webhooks to receive real-time notifications for events like:

Job created, updated, or completed
Technician checked in or out
Invoice paid
Customer feedback received

Rate Limits

Starter

100 requests/hour

Professional

1,000 requests/hour

Enterprise

Custom limits

SDKs & Libraries

Official SDKs and client libraries for popular programming languages:

JavaScript

npm i @synchq/api

Python

pip install synchq

PHP

Coming soon

Ruby

Coming soon

Ready to Build?

Get started with the SyncHQ Pro API today. Contact our team to request API access and receive your credentials.