CleanLife Partner API

Welcome to the CleanLife Partner API — the integration layer that lets authorized third-party platforms embed CleanLife home services directly into their products.

Getting Started

Set up your API key and make your first call in minutes.

Authentication

API key auth, permissions model, and security best practices.

Find or Create Contact

Create a contact and optional service address before booking.

Create a Booking

The core endpoint — create bookings on behalf of your customers.

What You Can Do

Browse Catalog

Query categories and services available at an address.

Manage Bookings

Create, cancel, and track bookings end-to-end.

Handle Payments

Confirm payments for PARTNER responsibility accounts.

SDK Examples

Ready-to-use code in cURL, JS, TypeScript, Python, C#, PHP.

Quick Start

# 1. Register contact and address
curl -X POST "https://apiv3.thecleanlife.dev/v1/partners/contacts" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+966500000000",
    "name": "Ahmed Ali",
    "latitude": "24.7136",
    "longitude": "46.6753",
    "cityName": "Riyadh",
    "districtName": "Al Olaya",
    "streetName": "King Fahd Road"
  }'

# 2. List services available at that address
curl -X GET "https://apiv3.thecleanlife.dev/v1/partners/services?addressId=ADDR_ID&page=1&limit=50" \
  -H "x-api-key: YOUR_API_KEY"

# 3. Check available timeslots
curl -X GET "https://apiv3.thecleanlife.dev/v1/partners/timeslots/available?addressId=ADDR_ID&serviceId=SVC_ID&date=2026-06-20" \
  -H "x-api-key: YOUR_API_KEY"

# 4. Create a booking
curl -X POST "https://apiv3.thecleanlife.dev/v1/partners/bookings" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalReference": "ORDER-001",
    "contactId": "...",
    "addressId": "...",
    "serviceId": "...",
    "date": "2026-06-20",
    "timeslot": { "startAt": "09:00", "endAt": "12:00" }
  }'

Environments

Environment	Base URL
Sandbox (default in examples)	`https://apiv3.thecleanlife.dev/v1`
Production	`https://api.cleanlife.sa/v1`

All partner endpoints are prefixed with /partners:

https://apiv3.thecleanlife.dev/v1/partners/...

Support

Contact the CleanLife integration team for: API key provisioning, permission grants, rate limit increases, and technical support. Always include the X-Request-Id from error responses when reporting issues.

Overview

Integration

Data Models

Getting Started

Authentication

Find or Create Contact

Create a Booking

What You Can Do

Browse Catalog

Manage Bookings

Handle Payments

SDK Examples

Quick Start

Environments

Support

Getting Started

Authentication

Find or Create Contact

Create a Booking

​What You Can Do

Browse Catalog

Manage Bookings

Handle Payments

SDK Examples

​Quick Start

​Environments

​Support

What You Can Do

Quick Start

Environments

Support