OtesseOtesseDocs

Quick Start Guide

This guide walks you through making your first API call to Otesse in under 10 minutes.

Prerequisites

  • An Otesse admin account
  • A test API key (see API Keys)
  • A tool for making HTTP requests (curl, Postman, or your language's HTTP library)

Step 1: Get Your API Key

  1. Log into the Otesse admin dashboard
  2. Go to Settings > Integrations > API Keys
  3. Click Generate New Key
  4. Select "Test" environment
  5. Copy the key (starts with otessetestsk_)

Step 2: Make Your First Request

List all customers:

curl -X GET https://api.otesse.com/v1/customers \
  -H "Authorization: Bearer otesse_test_sk_YOUR_KEY_HERE"

You should receive a JSON response with your customer data.

Step 3: Create a Customer

curl -X POST https://api.otesse.com/v1/customers \
  -H "Authorization: Bearer otesse_test_sk_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Test",
    "last_name": "Customer",
    "email": "test@example.com",
    "phone": "+15551234567",
    "address": {
      "label": "Home",
      "street": "123 Test Street",
      "city": "Eugene",
      "state": "OR",
      "zip": "97401"
    }
  }'

Step 4: Check Availability

curl -X GET "https://api.otesse.com/v1/services/availability?zip=97401&industry=cleaning&date=2026-03-15" \
  -H "Authorization: Bearer otesse_test_sk_YOUR_KEY_HERE"

Step 5: Create a Booking

curl -X POST https://api.otesse.com/v1/bookings \
  -H "Authorization: Bearer otesse_test_sk_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "CUSTOMER_ID_FROM_STEP_3",
    "industry": "cleaning",
    "configuration": {
      "bedrooms": 2,
      "bathrooms": 1,
      "frequency": "one-time"
    },
    "scheduled_at": "2026-03-15T10:00:00Z",
    "address_id": "ADDRESS_ID_FROM_STEP_3"
  }'

Test Environment

The test environment (otessetest keys) provides:

  • Full API functionality with no real charges
  • Test payment processing (no real money moves)
  • Isolated data — test data does not affect production
  • Stripe test mode integration

Use test card number 4242 4242 4242 4242 with any future expiration date for payment testing.

Next Steps

REST API Integration