Build on top of yAppointment with a REST API, OAuth, webhooks, and a TypeScript SDK

Developer Hub & Public API

Everything developers need to integrate yAppointment into their own products — a public REST API, OAuth 2.1 for user-delegated access, signed webhooks, and a ready-to-use TypeScript SDK.

Read the Docs

A Complete Developer Platform

Production-ready building blocks to connect yAppointment with your apps, workflows, and integrations

Public REST API

A clean, predictable REST API at /api/v1 to read and write your company, booking, and customer data — with idempotency keys so retries never double-book.

  • Read and write company, booking, and customer data
  • Idempotent booking creation with idempotency keys
  • Manage your webhook endpoints programmatically
  • Prices returned in minor units (cents) for precise calculations
  • Consistent, well-structured JSON responses

OAuth 2.1 + PKCE

Let your users connect their yAppointment account to your app securely with the Authorization-Code flow and PKCE — no password sharing, scoped access only.

  • Authorization-Code flow with PKCE for safe user-delegated access
  • Granular scopes: read/write:bookings and read/write:customers
  • Profile and analytics access via read:profile and read:analytics
  • Webhook management through the webhooks:manage scope
  • Users grant access without ever sharing credentials

Server & Public API Keys

Issue server keys (yapp_sk_*) for backend integrations and public keys (yapp_pk_*) for client-side use, with completely separate live and test environments.

  • Server keys (yapp_sk_*) for trusted server-to-server calls
  • Public keys (yapp_pk_*) for safe client-side usage
  • Separate live and test environments to develop with confidence
  • Rotate keys at any time from your dashboard
  • Test against sandbox data before going live

Signed Webhooks

Get notified the moment something changes. yAppointment delivers 9 event types to your HTTPS endpoints with automatic retries and full delivery tracking.

  • 9 event types covering bookings, customers, services, and employees
  • booking.created, booking.updated, and booking.cancelled events
  • HTTPS-only endpoints with a whsec_ signing secret
  • HMAC-SHA256 signatures in the yapp-signature header
  • Automatic retries with delivery tracking, plus test deliveries from the dashboard

Getting Started

Start building with our SDK or REST API in minutes. Full documentation and interactive examples at developers.yappointment.com.

View Documentation
api-example.ts
import { YAppointmentClient } from
  '@lohisoftsro/yappointment-sdk';

const client = new YAppointmentClient({
  apiKey: process.env.API_KEY,
  baseUrl: 'https://api.yappointment.com'
});

// Create a booking
const booking = await client.bookings.create({
  serviceId: 'srv_123',
  customerId: 'cst_456',
  startTime: '2025-07-01T10:00:00Z',
  idempotencyKey: 'req_xyz789'
});

console.log('Booked:', booking.id);

Built for a Great Developer Experience

The tooling and documentation that make integrating yAppointment fast and pleasant

TypeScript SDK

Skip the boilerplate with our official TypeScript SDK on npm — @lohisoftsro/yappointment-sdk — generated straight from our OpenAPI spec, with ESM and CJS support.

Interactive Developer Docs

Explore every endpoint at developers.yappointment.com with an interactive Scalar API reference you can read, search, and try out as you build.

Live & Test Modes

Separate live and test API keys let you build and experiment safely, then flip to production when you are ready — without touching real data.

Safe Retries

Idempotency keys make booking creation safe to retry, so network hiccups never turn into duplicate appointments.

Ready to see what changes?

14 days. Full access. No credit card. What do you have to lose?

Business owners across Europe have replaced admin chaos with one platform that just works. Join them today.

14-day free trial • Commission-free — always • Cancel anytime