DispatchIQDispatchIQ
How It WorksPricingBlogAboutContactLog inGet Started
API Reference

API Documentation

Complete reference for the DispatchIQ REST API. Base URL: https://api.dispatchiq.com

Get API KeysAPI Platform Overview

Authentication

All API requests require a Bearer token in the Authorization header. Obtain your API key from the developer dashboard.

Authorization: Bearer diq_sk_live_your_api_key_here
Rate limit: 1,000 req/minJSON responsesTLS 1.2+ required

Endpoints

Jobs

Create, manage, and query service jobs.

POST/v1/jobsCreate a new job
GET/v1/jobsList jobs with filters and pagination
GET/v1/jobs/:idRetrieve a specific job
PATCH/v1/jobs/:idUpdate job details
POST/v1/jobs/:id/cancelCancel a pending job

Dispatch

AI-powered technician matching and routing.

POST/v1/dispatch/matchFind best-matched technicians for a job
POST/v1/dispatch/assignAssign a technician to a job
GET/v1/dispatch/availabilityCheck technician availability by area
POST/v1/dispatch/emergencyTrigger emergency dispatch routing

Scan

AI hazard detection and photo analysis.

POST/v1/scanSubmit a photo for hazard scanning
GET/v1/scan/:idRetrieve scan results
POST/v1/scan/batchSubmit multiple photos for batch scanning
GET/v1/scan/:id/reportGet formatted PDF report

Verification

AI work verification via before/after photos.

POST/v1/verifySubmit before/after photos for verification
GET/v1/verify/:idRetrieve verification result
POST/v1/verify/:id/disputeDispute a verification result

Payments

Stripe Connect payment processing and escrow.

POST/v1/payments/chargeCreate a payment intent with escrow hold
POST/v1/payments/:id/releaseRelease escrow to technician
POST/v1/payments/:id/refundRefund a payment to homeowner
GET/v1/paymentsList payment transactions

Technicians

Technician profiles, merit scores, and credentials.

GET/v1/techniciansList technicians with filters
GET/v1/technicians/:idRetrieve technician profile and merit score
GET/v1/technicians/:id/passportGet public Tech Passport data
GET/v1/technicians/:id/reviewsList technician reviews

Fleet

DIQ Fleet logistics and driver dispatch.

POST/v1/fleet/ridesRequest a technician transit ride
POST/v1/fleet/hotshotRequest an urgent parts delivery
GET/v1/fleet/rides/:idTrack a ride in real time
GET/v1/fleet/driversList available fleet drivers

Webhooks

Event subscriptions for real-time updates.

POST/v1/webhooksCreate a webhook subscription
GET/v1/webhooksList active webhook subscriptions
DELETE/v1/webhooks/:idDelete a webhook subscription
GET/v1/webhooks/:id/logsView delivery logs for a webhook

Example: Create a Job

Request

curl -X POST https://api.dispatchiq.com/v1/jobs \
  -H "Authorization: Bearer diq_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "category": "plumbing",
    "description": "Leaking kitchen faucet, dripping constantly",
    "address": "123 Main St, Troy, MI 48084",
    "urgency": "standard",
    "photos": ["https://storage.dispatchiq.com/uploads/abc123.jpg"],
    "contact": {
      "name": "Jane Smith",
      "phone": "+15551234567"
    }
  }'

Response 200 OK

{
  "id": "job_abc123def456",
  "object": "job",
  "status": "pending_match",
  "category": "plumbing",
  "description": "Leaking kitchen faucet, dripping constantly",
  "address": {
    "line1": "123 Main St",
    "city": "Troy",
    "state": "MI",
    "zip": "48084"
  },
  "urgency": "standard",
  "estimated_price_cents": 15000,
  "matched_technician": null,
  "verification_status": null,
  "payment_status": "pending",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Error Codes

Code
Status
Description
400
Bad Request
Invalid request body or parameters
401
Unauthorized
Missing or invalid API key
403
Forbidden
Insufficient permissions
404
Not Found
Resource does not exist
409
Conflict
Resource state conflict (e.g., job already assigned)
429
Rate Limited
Too many requests, retry after cooldown
500
Server Error
Internal server error, contact support

Need help integrating? Reach out to our developer support team.

Request API AccessBack to Home

DispatchIQ

AI-powered home services platform. Detroit, MI.

U.S. Patent Pending

For You

HomeownersCompanies

Product

Hazard ScannerAPI PlatformAboutLegal

Get Started

Create AccountSign InAPI Docs
© 2026 DispatchIQ LLC. All rights reserved.