Lorenly.

API reference

Build on Lorenly - read your services and availability, list bookings, and react to events in real time. A small, predictable REST API over HTTPS that returns JSON.

Pro API access is a Pro feature. Create and manage keys in the console under Settings → Embed & API.
↓ Download OpenAPI spec

Machine-readable OpenAPI 3.0 - generate a typed client SDK from it (e.g. with openapi-generator).

Authentication

Every request to /api/ext/v1 is authenticated with an API key sent as a Bearer token in the Authorization header.

Mint an API key in the console under Settings → Embed & API (Pro plan). The raw key is shown exactly once at creation - store it securely, as it can't be recovered later. Send it on every /api/ext/v1 request as 'Authorization: Bearer <api_key>'. Each key is scoped to a single salon account and only ever sees that account's own data.

Base URL
https://lorenly.com
Header
Authorization: Bearer <api_key>

Example request

curl https://lorenly.com/api/ext/v1/services \
  -H "Authorization: Bearer <api_key>"

Rate limits

The API is intended for back-office integrations, not high-volume traffic. Keep to a few requests per second per key; sustained bursts may be throttled (HTTP 429). Booking creation is additionally guarded against double-booking the same staff member.

Bookings

Read, create and cancel appointments for your salon. Times in responses are UTC, marked with a trailing 'Z'. Times you SEND (create/reschedule start) may carry an explicit offset or 'Z'; a bare string like '2026-06-01T10:00:00' is read as your salon's local wall-clock time.

GET/api/ext/v1/bookings

List your bookings, scoped to your team, ordered by id. Cursor-paginated: pass starting_after with the previous page's nextCursor to fetch the next page; stop when hasMore is false. Optional filters narrow the list (none = all bookings, as before). Each booking also carries (additive): serviceId, staffId, staffName, locationId, createdAt, updatedAt, rescheduled, noShow, isClass, createdVia, clientId, clientNote, staffNote (internal), cancellationReason, currency, amountNet, pricing, deposit, visit and links. `amount` is the GROSS amount (before coupon/loyalty discounts); `amountNet` is the amount your console and reports show. `deposit.state` is none | required_unpaid | expired | paid | waived | refunded and is derived only from confirmed payments - a deposit that was requested but never paid is never reported as paid. `links.payUrl` is set only while an online deposit is still due.

Query parameters
limitMax rows to return (default 50, max 200).
starting_afterBooking id cursor - return rows after this id. Use the nextCursor from the previous page.
statusFilter by status: accepted, pending, cancelled, rejected or awaiting_host. Repeat it or comma-separate several.
staff_idOnly bookings with this staff member (ids from GET /api/ext/v1/staff).
service_slugOnly bookings for this service.
start_fromOnly bookings starting at or after this time (ISO 8601; a bare time is your salon's local time).
start_toOnly bookings starting before this time (ISO 8601).
updated_sinceOnly bookings created or changed at or after this time - pass the largest updatedAt you have seen to sync changes.
client_emailOnly bookings for this client email (case-insensitive).
location_idA location id from GET /api/ext/v1/locations (default: your primary location).
Example response
{
  "data": [
    {
      "uid": "abc123def456ghi789jkl0",
      "id": 4821,
      "title": "Sample Service",
      "start": "2026-06-01T08:00:00Z",
      "end": "2026-06-01T08:30:00Z",
      "status": "accepted",
      "serviceSlug": "sample-service",
      "amount": 30.0,
      "clientName": "Jane Doe",
      "clientEmail": "[email protected]",
      "clientPhone": "+41 79 123 45 67",
      "language": "en",
      "serviceId": 102,
      "staffId": 7,
      "staffName": "Staff Member",
      "locationId": 3,
      "createdAt": "2026-05-28T09:12:44Z",
      "updatedAt": "2026-05-28T09:12:44Z",
      "rescheduled": false,
      "noShow": false,
      "isClass": false,
      "createdVia": "booking_page",
      "clientId": 311,
      "clientNote": "First visit.",
      "staffNote": "Prefers a quiet room.",
      "cancellationReason": "Client asked to cancel",
      "currency": "EUR",
      "amountNet": 27.0,
      "pricing": {
        "gross": 30.0,
        "net": 27.0,
        "discount": 3.0,
        "loyaltyDiscount": 0.0,
        "addonsTotal": 5.0,
        "tip": 0.0,
        "couponCode": "WELCOME10",
        "addons": [
          {
            "id": 4,
            "name": "Scalp massage",
            "price": 5.0
          }
        ]
      },
      "deposit": {
        "state": "paid",
        "required": true,
        "amountDue": "10.00",
        "amountPaid": "10.00",
        "amountRefunded": null,
        "paidAt": "2026-05-28T09:13:02Z",
        "needsReview": false,
        "forfeited": false,
        "totalDue": "27.00",
        "paidInFull": false,
        "balanceDue": "17.00",
        "balanceSettled": false,
        "depositPaid": true
      },
      "visit": {
        "groupUid": "vis_8f2k1m",
        "position": 0
      },
      "links": {
        "manageUrl": "https://lorenly.com/my-bookings?slug=my-salon",
        "icsUrl": "https://lorenly.com/api/public/booking/my-salon/ics?uid=abc123def456ghi789jkl0",
        "payUrl": null
      }
    }
  ],
  "hasMore": true,
  "nextCursor": 4821
}
GET/api/ext/v1/bookings/{uid}

Fetch a single booking by its uid. Includes `answers`: the client's booking-form answers with each question's current label (intake/consent answers are flagged sensitive) and the questions left unanswered. Each booking also carries (additive): serviceId, staffId, staffName, locationId, createdAt, updatedAt, rescheduled, noShow, isClass, createdVia, clientId, clientNote, staffNote (internal), cancellationReason, currency, amountNet, pricing, deposit, visit and links. `amount` is the GROSS amount (before coupon/loyalty discounts); `amountNet` is the amount your console and reports show. `deposit.state` is none | required_unpaid | expired | paid | waived | refunded and is derived only from confirmed payments - a deposit that was requested but never paid is never reported as paid. `links.payUrl` is set only while an online deposit is still due.

Query parameters
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Example response
{
  "uid": "abc123def456ghi789jkl0",
  "id": 4821,
  "title": "Sample Service",
  "start": "2026-06-01T08:00:00Z",
  "end": "2026-06-01T08:30:00Z",
  "status": "accepted",
  "serviceSlug": "sample-service",
  "amount": 30.0,
  "clientName": "Jane Doe",
  "clientEmail": "[email protected]",
  "clientPhone": "+41 79 123 45 67",
  "language": "en",
  "serviceId": 102,
  "staffId": 7,
  "staffName": "Staff Member",
  "locationId": 3,
  "createdAt": "2026-05-28T09:12:44Z",
  "updatedAt": "2026-05-28T09:12:44Z",
  "rescheduled": false,
  "noShow": false,
  "isClass": false,
  "createdVia": "booking_page",
  "clientId": 311,
  "clientNote": "First visit.",
  "staffNote": "Prefers a quiet room.",
  "cancellationReason": "Client asked to cancel",
  "currency": "EUR",
  "amountNet": 27.0,
  "pricing": {
    "gross": 30.0,
    "net": 27.0,
    "discount": 3.0,
    "loyaltyDiscount": 0.0,
    "addonsTotal": 5.0,
    "tip": 0.0,
    "couponCode": "WELCOME10",
    "addons": [
      {
        "id": 4,
        "name": "Scalp massage",
        "price": 5.0
      }
    ]
  },
  "deposit": {
    "state": "paid",
    "required": true,
    "amountDue": "10.00",
    "amountPaid": "10.00",
    "amountRefunded": null,
    "paidAt": "2026-05-28T09:13:02Z",
    "needsReview": false,
    "forfeited": false,
    "totalDue": "27.00",
    "paidInFull": false,
    "balanceDue": "17.00",
    "balanceSettled": false,
    "depositPaid": true
  },
  "visit": {
    "groupUid": "vis_8f2k1m",
    "position": 0
  },
  "links": {
    "manageUrl": "https://lorenly.com/my-bookings?slug=my-salon",
    "icsUrl": "https://lorenly.com/api/public/booking/my-salon/ics?uid=abc123def456ghi789jkl0",
    "payUrl": null
  },
  "answers": {
    "items": [
      {
        "name": "referralSource",
        "label": "How did you hear about us?",
        "labels": {
          "en": "How did you hear about us?",
          "fr": "Comment nous avez-vous connus ?"
        },
        "type": "radio",
        "kind": "text",
        "value": "instagram",
        "valueLabels": [
          {
            "en": "Instagram"
          }
        ],
        "sensitive": false
      },
      {
        "name": "salonform_12_no_allergies",
        "label": "I have no known allergies",
        "labels": {
          "en": "I have no known allergies"
        },
        "type": "consent",
        "kind": "boolean",
        "value": "yes",
        "bool": true,
        "sensitive": true
      }
    ],
    "unanswered": [
      {
        "name": "notes_extra",
        "label": "Anything else?",
        "labels": {
          "en": "Anything else?"
        }
      }
    ]
  }
}
POST/api/ext/v1/bookings

Create a booking. Identify the service by serviceSlug OR eventTypeId. The end time is computed from durationMin, or the service's default length when omitted. staffId and note are optional. By default the same rules as your online booking page apply: the service must be bookable online, the start must be a time GET /api/ext/v1/availability offers (opening and staff hours, minimum notice, maximum days ahead, no clash) and a staffId must offer the service; without staffId a free staff member is assigned automatically. Pass "admin": true to skip ONLY the availability and booking-window rules (outside hours, minimum notice, no free slot) - like an admin booking by hand; the service, staff and double-booking checks still apply and the booking is marked created_via=pro_api_admin. Errors carry a stable `code`: 400 service_not_bookable | staff_not_offering_service, 409 slot_in_past | outside_booking_window | slot_unavailable | staff_booked | staff_unavailable, 503 availability_unavailable (retry). Optional (additive): customAnswers - answers to the service's booking questions keyed by field name (GET /api/ext/v1/forms/global?mode=common); when sent, questions the service doesn't declare are dropped and required ones are enforced (400 missing_required_answers). waitlistEntryId - convert a waitlist entry: it is marked booked and linked to the new booking in the same transaction (404 unknown entry, 409 already booked). sendConfirmation - send your salon's confirmation email/SMS to the client (default false). locationId - book at another of your locations. The booking is stamped with the service's booking-page price (so `amount` is set) and the client is filed in your client list. The response adds `links`. Additional error codes: 400 invalid_answers (customAnswers is not an object) | missing_required_answers, 404 unknown_location (locationId is not one of your locations); a waitlist entry that is unknown returns 404 and one already converted returns 409.

Request body
serviceSlugsample-service
eventTypeId102
start2026-06-01T10:00:00
durationMin30
attendee{"name": "Jane Doe", "email": "[email protected]", "phone": "+41 79 123 45 67"}
staffId7
noteFirst visit - slight latex allergy.
adminfalse
customAnswers{"referralSource": "instagram", "salonform_12_no_allergies": true}
waitlistEntryId12
sendConfirmationtrue
locationId3
Example response
{
  "uid": "abc123def456ghi789jkl0",
  "id": 4821,
  "status": "accepted",
  "links": {
    "manageUrl": "https://lorenly.com/my-bookings?slug=my-salon",
    "icsUrl": "https://lorenly.com/api/public/booking/my-salon/ics?uid=abc123def456ghi789jkl0",
    "payUrl": null
  }
}
POST/api/ext/v1/bookings/{uid}/cancel

Cancel a booking by uid (sets its status to 'cancelled'). Optional body {reason}: stored as the cancellation reason shown in your console. Coupon, gift-card and loyalty credit used at booking time is restored.

Query parameters
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Request body
reasonClient asked to cancel
Example response
{
  "ok": true,
  "status": "cancelled"
}
POST/api/ext/v1/bookings/{uid}/reschedule

Move a booking to a new time. The end is recomputed from durationMin (or the service length); a staff clash returns 409. The new start must be an available time; pass "admin": true to skip only that availability check (the past-time, staff double-booking and class-capacity checks still apply).

Query parameters
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Request body
start2026-06-02T11:45:00
durationMin30
adminfalse
Example response
{
  "ok": true,
  "uid": "abc123def456ghi789jkl0",
  "start": "2026-06-02T09:45:00Z",
  "end": "2026-06-02T10:15:00Z"
}
GET/api/ext/v1/staff

Staff who can be booked online (never hidden, disabled or over your plan limit), each with the service slugs they offer. Use the ids as staffId (create) and staff (availability).

Query parameters
serviceSlugOnly the staff offering this service.
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Example response
{
  "staff": [
    {
      "id": 7,
      "name": "Staff Member",
      "title": "Senior stylist",
      "photoUrl": "https://cdn.example.com/staff/7.jpg",
      "services": [
        "sample-service"
      ]
    }
  ]
}
GET/api/ext/v1/locations

Your locations. `primary` marks the one every endpoint uses when you pass no location; pass another id as location_id / locationId.

Example response
{
  "locations": [
    {
      "id": 3,
      "name": "Main salon",
      "slug": "main",
      "timezone": "Europe/Zurich",
      "bookingSlug": "my-salon",
      "primary": true
    }
  ]
}

Services

Your bookable service menu and real-time availability.

GET/api/ext/v1/services

List your bookable services. Each carries its category; `categories` / `categoryOrder` give your categories in the order you set in the console - sort category lists by it. Each service also carries (additive): id (the eventTypeId), bookable, and the booking page's own view of it - bookingPrice/bookingCurrency (what the booking page shows and charges; `price` stays the service's base price), deposit (the deposit rule), staff (who can be booked online), addons, isClass, seats and deal. These read null when the location has no booking page.

Query parameters
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Example response
{
  "services": [
    {
      "slug": "sample-service",
      "title": "Sample Service",
      "durationMinutes": 30,
      "price": 30.0,
      "currency": "EUR",
      "category": "Hair",
      "categoryKey": "hair",
      "id": 102,
      "bookable": true,
      "bookingPrice": 32.0,
      "bookingCurrency": "EUR",
      "deposit": {
        "required": true,
        "amount": 16.0,
        "mode": "default",
        "value": 0.0,
        "defaultPercent": 50.0
      },
      "staff": [
        {
          "id": 7,
          "name": "Staff Member",
          "title": "Senior stylist",
          "photoUrl": "https://cdn.example.com/staff/7.jpg"
        }
      ],
      "addons": [
        {
          "id": 4,
          "name": "Scalp massage",
          "durationMin": 10,
          "price": 5.0
        }
      ],
      "isClass": false,
      "seats": 1,
      "deal": {
        "percentOff": 20,
        "couponCode": "DEAL-K7M2PQ"
      }
    }
  ],
  "categories": [
    {
      "key": "hair",
      "name": "Hair",
      "slug": "hair",
      "color": "#1A1A1A",
      "sortOrder": 0,
      "active": true
    }
  ],
  "categoryOrder": [
    "hair"
  ]
}
GET/api/ext/v1/categories

Your service categories in the order you set in the console (the single source of truth). Add ?includeHidden=1 to include categories hidden from customers.

Example response
{
  "categories": [
    {
      "key": "hair",
      "name": "Hair",
      "slug": "hair",
      "color": "#1A1A1A",
      "sortOrder": 0,
      "active": true
    }
  ],
  "categoryOrder": [
    "hair"
  ]
}
PUT/api/ext/v1/categories/order

Reorder your categories. Send category keys in the new order; unknown keys are rejected (400) and categories you leave out keep their relative order after the listed ones.

Request body
keys["nails", "hair"]
Example response
{
  "ok": true,
  "order": [
    "nails",
    "hair"
  ]
}
GET/api/ext/v1/services/{slug}

Fetch a single service's detail by slug, including its specific bookingFields. Also returns hidden (unlisted) services. Each service also carries (additive): id (the eventTypeId), bookable, and the booking page's own view of it - bookingPrice/bookingCurrency (what the booking page shows and charges; `price` stays the service's base price), deposit (the deposit rule), staff (who can be booked online), addons, isClass, seats and deal. These read null when the location has no booking page.

Query parameters
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Example response
{
  "slug": "sample-service",
  "title": "Sample Service",
  "durationMinutes": 30,
  "price": 30.0,
  "currency": "EUR",
  "description": "A short description of this service.",
  "bookingFields": [
    {
      "name": "notes",
      "type": "textarea",
      "required": false,
      "label": {
        "en": "Notes",
        "fr": "Notes / Précisions"
      }
    }
  ],
  "id": 102,
  "bookable": true,
  "bookingPrice": 32.0,
  "bookingCurrency": "EUR",
  "deposit": {
    "required": true,
    "amount": 16.0,
    "mode": "default",
    "value": 0.0,
    "defaultPercent": 50.0
  },
  "staff": [
    {
      "id": 7,
      "name": "Staff Member",
      "title": "Senior stylist",
      "photoUrl": "https://cdn.example.com/staff/7.jpg"
    }
  ],
  "addons": [
    {
      "id": 4,
      "name": "Scalp massage",
      "durationMin": 10,
      "price": 5.0
    }
  ],
  "isClass": false,
  "seats": 1,
  "deal": {
    "percentOff": 20,
    "couponCode": "DEAL-K7M2PQ"
  },
  "hidden": false
}
PATCH/api/ext/v1/services/{slug}

Update a service's price, duration and/or title. Send only the fields you want to change (at least one is required). price is in your salon's currency; duration is in minutes.

Request body
price35.0
duration45
titleSample Service
Example response
{
  "ok": true,
  "slug": "sample-service",
  "price": 35.0,
  "duration": 45,
  "title": "Sample Service"
}
GET/api/ext/v1/availability

Bookable start times (ISO 8601) for a service, with your salon's own rules already applied - minimum notice, how far ahead you allow booking, and each location's working hours. Pass `date` for one day, or `start`/`end` for a range (up to 92 days). This is the authoritative availability - what it returns is exactly what the booking endpoint will accept.

Query parameters
serviceSlugSlug of the service to check.
dateSingle day, YYYY-MM-DD. Use this OR start/end.
startRange start, YYYY-MM-DD (inclusive).
endRange end, YYYY-MM-DD (inclusive; defaults to start).
staffOnly times this staff member is free (an id from GET /api/ext/v1/staff).
location_idA location id from GET /api/ext/v1/locations (default: your primary location). Not one of yours: 404 unknown_location.
Example response
{
  "serviceSlug": "sample-service",
  "start": "2026-06-01",
  "end": "2026-06-02",
  "days": {
    "2026-06-01": [
      "2026-06-01T10:00:00.000+02:00",
      "2026-06-01T10:30:00.000+02:00"
    ],
    "2026-06-02": []
  }
}

Forms

Multi-language configurations for Global Questions and Service-Specific Forms.

GET/api/ext/v1/forms/global

Fetch the global booking questions (standard fields) with localization.

Example response
{
  "fields": [
    {
      "name": "name",
      "type": "name",
      "required": true,
      "label": {
        "en": "Full name",
        "fr": "Nom complet"
      }
    },
    {
      "name": "referralSource",
      "type": "radio",
      "required": false,
      "label": {
        "en": "How did you hear about us?",
        "fr": "Comment avez-vous entendu parler de nous?"
      },
      "options": [
        {
          "label": {
            "en": "Instagram",
            "fr": "Instagram"
          },
          "value": "instagram"
        }
      ]
    }
  ]
}
GET/api/ext/v1/forms

List all active service-specific (intake) forms and their attachments.

Example response
{
  "forms": [
    {
      "id": 1,
      "name": "Consent Form",
      "description": "Lash lift consent",
      "fields": [
        {
          "name": "allergy",
          "type": "checkbox",
          "required": true,
          "label": {
            "en": "I have no allergies",
            "fr": "Je n'ai pas d'allergies"
          }
        }
      ],
      "links": [
        {
          "scope": "service",
          "ref": "rehaussement-cils"
        }
      ]
    }
  ]
}

Clients

Your CRM - client profiles and their visit history.

GET/api/ext/v1/clients

List your clients with visit counts and last-visit dates, ordered by id. Cursor-paginated: pass starting_after with the previous page's nextCursor to fetch the next page; stop when hasMore is false.

Query parameters
limitMax rows to return (default 50, max 200).
starting_afterClient id cursor - return rows after this id. Use the nextCursor from the previous page.
qFilter by name or email substring.
Example response
{
  "data": [
    {
      "email": "[email protected]",
      "name": "Jane Doe",
      "phone": "+41 79 123 45 67",
      "totalVisits": 4,
      "lastVisit": "2026-05-12T14:30:00"
    }
  ],
  "hasMore": true,
  "nextCursor": 318
}
GET/api/ext/v1/clients/{email}

A client's profile plus their recent bookings (team-scoped).

Example response
{
  "email": "[email protected]",
  "name": "Jane Doe",
  "phone": "+41 79 123 45 67",
  "notes": "Prefers afternoon appointments.",
  "birthDate": "1990-03-21",
  "totalVisits": 4,
  "bookings": [
    {
      "uid": "abc123def456ghi789jkl0",
      "id": 4821,
      "title": "Sample Service",
      "start": "2026-05-12T12:30:00Z",
      "end": "2026-05-12T13:00:00Z",
      "status": "accepted",
      "serviceSlug": "sample-service",
      "amount": 30.0,
      "clientName": "Jane Doe",
      "clientEmail": "[email protected]",
      "clientPhone": "+41 79 123 45 67"
    }
  ]
}

Catalog

Public-facing salon profile, reviews, deals, memberships and coupon checks.

GET/api/ext/v1/business

Your salon's business profile (address, contact, hours, socials).

Example response
{
  "name": "My Salon",
  "address": "Rue du Commerce 12, 1204 Genève",
  "street": "Rue du Commerce 12",
  "city": "Genève",
  "postalCode": "1204",
  "country": "CH",
  "phone": "+41 22 123 45 67",
  "email": "[email protected]",
  "website": "https://example.com",
  "hours": [
    {
      "days": [
        1,
        2,
        3,
        4,
        5
      ],
      "opens": "09:00",
      "closes": "18:00"
    }
  ],
  "currency": "EUR",
  "latitude": 46.2044,
  "longitude": 6.1432,
  "priceRange": "$$",
  "paymentAccepted": "Cash, Visa, Mastercard, TWINT",
  "socials": {
    "instagram": "https://instagram.com/mysalon",
    "tiktok": "",
    "googleMaps": "https://maps.google.com/?cid=123",
    "directions": "https://maps.google.com/dir/?api=1&destination=..."
  }
}
GET/api/ext/v1/reviews

Your approved customer reviews plus the aggregate rating.

Query parameters
limitMax reviews to return (default 50, max 200).
offsetReviews to skip for pagination (default 0).
Example response
{
  "ratingValue": 4.8,
  "ratingCount": 126,
  "reviews": [
    {
      "id": 91,
      "authorName": "Jane D.",
      "rating": 5,
      "body": "Service impeccable, je reviendrai !",
      "verified": true,
      "reply": "Merci Jane, à bientôt !",
      "createdAt": "2026-05-10T16:22:00"
    }
  ]
}
GET/api/ext/v1/deals

Your currently-live last-minute deals.

Example response
{
  "deals": [
    {
      "title": "Mardi tranquille -20%",
      "discountPct": 20,
      "scope": "all",
      "serviceSlug": null,
      "couponCode": "DEAL-K7M2PQ",
      "endsAt": "2026-06-03T18:00:00+02:00"
    }
  ]
}
GET/api/ext/v1/memberships

Your active membership plans.

Example response
{
  "memberships": [
    {
      "id": 3,
      "name": "VIP mensuel",
      "price": 49.0,
      "interval": "monthly",
      "includedCredits": 1,
      "discountPct": 10.0,
      "perks": "1 soin offert + 10% sur tout le reste."
    }
  ]
}
GET/api/ext/v1/waitlist

Your active waitlist entries (clients waiting for a spot). Each entry also carries (additive) status, preferred, serviceName, locationId, clientId, notifiedAt, bookedAt and the booking it was converted into. Convert an entry by creating a booking with waitlistEntryId.

Query parameters
statuswaiting (default), contacted, booked, cancelled or all.
location_idOnly entries for this location (plus entries for any location).
limitMax rows to return (default 50, max 200).
offsetRows to skip (default 0).
Example response
{
  "entries": [
    {
      "id": 12,
      "name": "Jane D.",
      "email": "[email protected]",
      "phone": "",
      "service": "pose-classique",
      "notes": "",
      "language": "fr",
      "createdAt": "2026-05-20T10:00:00",
      "status": "booked",
      "preferred": "Tuesday mornings",
      "serviceName": "Pose classique",
      "locationId": 3,
      "clientId": 311,
      "notifiedAt": "2026-05-21T08:00:00+00:00",
      "bookedAt": "2026-05-21T09:30:00+00:00",
      "booking": {
        "id": 4821,
        "uid": "abc123def456ghi789jkl0",
        "status": "accepted"
      }
    }
  ]
}
POST/api/ext/v1/waitlist

Add a client to the waitlist; they're alerted automatically in their language when a matching slot frees up.

Request body
nameJane Doe
email[email protected]
servicepose-classique
localefr
locationId3
Example response
{
  "ok": true,
  "id": 13
}
GET/api/ext/v1/templates

List your message templates (event, channel, locales).

Example response
{
  "templates": [
    {
      "id": 4,
      "name": "Booking cancelled",
      "event": "booking_cancellation",
      "channel": "email",
      "active": true,
      "isDefault": true,
      "locales": [
        "fr",
        "en"
      ]
    }
  ]
}
POST/api/ext/v1/emails/send

Send a styled (branded HTML) email to a customer - via one of your templates ('event') or a custom subject/body wrapped in your salon's branded shell. Sent on demand (transactional).

Request body
to[email protected]
subjectA little reminder
body["Your next visit is coming up.", "See you soon!"]
ctaLabelBook again
ctaUrlhttps://lorenly.com/book/your-salon
localefr
Example response
{
  "ok": true,
  "delivered": true
}
POST/api/ext/v1/reviews/request

Send a styled review-request email (uses your configured review URL + copy). Trigger it from your POS/CRM after a visit. delivered=false if no review URL is configured.

Request body
to[email protected]
nameJane
localefr
Example response
{
  "ok": true,
  "delivered": true
}
POST/api/ext/v1/coupons/validate

Check whether a coupon code is valid for a service and base price, and what it would discount. This is a read - it does NOT redeem the code.

Request body
codeDEAL-K7M2PQ
serviceSlugsample-service
base30.0
Example response
{
  "valid": true,
  "discount": 6.0,
  "reason": null
}

Loyalty

Read and adjust a client's loyalty point balance.

GET/api/ext/v1/loyalty/{email}

Fetch a client's current loyalty point balance and their last 20 ledger entries.

Example response
{
  "email": "[email protected]",
  "balance": 340,
  "history": [
    {
      "points": 50,
      "reason": "booking #4821",
      "createdAt": "2026-05-12T14:30:00"
    },
    {
      "points": -100,
      "reason": "redeemed",
      "createdAt": "2026-04-20T11:00:00"
    }
  ]
}
POST/api/ext/v1/loyalty/{email}/adjust

Manually add or remove points for a client. Pass a negative points value to deduct. Returns the new balance after the adjustment.

Request body
points50
reasonIn-store gift
Example response
{
  "ok": true,
  "newBalance": 390
}

Packages

Read package purchase records.

GET/api/ext/v1/packages/purchases

List paid package purchases, newest first (max 100). Filter by buyer email with the optional email query param.

Query parameters
emailFilter to purchases by this buyer email address.
Example response
{
  "purchases": [
    {
      "id": 17,
      "email": "[email protected]",
      "name": "Jane Doe",
      "package": "10-Visit Pack",
      "kind": "credits",
      "code": "PKG-ABC123",
      "status": "paid",
      "createdAt": "2026-05-28T09:15:00"
    }
  ]
}

Webhooks

Register HTTPS endpoints in the console (Settings → Webhooks) and we POST a signed JSON payload the moment a subscribed event happens. Respond with any 2xx status to acknowledge; non-2xx responses and timeouts are recorded as failed deliveries and retried. booking.updated fires when a live booking changes (time, staff, status, no-show, notes). Booking payloads also carry (additive) id, serviceId, staffId, locationId, amount (gross, as in the API), amountNet, deposit (the confirmed-payment state), noShow, cancellationReason and attendee.phone.

Events

  • booking.created
  • booking.cancelled
  • booking.updated
  • review.created
  • client.created
  • package.purchased
  • invoice.paid
  • invoice.sent
  • membership.started
  • sale.completed

Signature

Every request carries two headers: X-Webhook-Event names the event, and X-Webhook-Signature is the lowercase hex HMAC-SHA256 of the raw request body computed with your webhook's signing secret (shown once when you create the webhook). Recompute the HMAC over the exact bytes you receive and compare it in constant time before trusting a payload. Each body also includes a unique id field for idempotency/dedup.

Example payload

{
  "event": "booking.created",
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "booking": {
    "uid": "abc123def456ghi789jkl0",
    "title": "Signature Facial",
    "start": "2026-06-01T08:00:00Z",
    "end": "2026-06-01T09:00:00Z",
    "status": "accepted",
    "service": "signature-facial",
    "attendee": {
      "name": "First Last",
      "email": "[email protected]",
      "phone": "+41 79 000 00 00"
    },
    "id": 4821,
    "serviceId": 102,
    "staffId": 7,
    "locationId": 3,
    "amount": 30.0,
    "amountNet": 27.0,
    "deposit": {
      "state": "paid",
      "required": true,
      "amountDue": "10.00",
      "amountPaid": "10.00",
      "amountRefunded": null,
      "paidAt": "2026-05-28T09:13:02Z",
      "needsReview": false,
      "forfeited": false,
      "totalDue": "27.00",
      "paidInFull": false,
      "balanceDue": "17.00",
      "balanceSettled": false,
      "depositPaid": true
    },
    "noShow": false,
    "cancellationReason": null
  }
}