Clientlyopenapi.json
Åpent API

La en agent booke timen.

Alt kundene kan gjøre på bookingsiden, kan en agent gjøre over HTTP: lese tjenester, finne ledige tider, booke og avbestille. Samme regler, samme database – ingen snarveier.

Ingen API-nøkkel

Å lese en bedrift, tjenestene og ledige tider krever ingenting – det er allerede offentlig på bookingsiden. Å booke krever heller ingen nøkkel, men du får en «manage_token» tilbake. Den er den eneste veien tilbake til bookingen, så ta vare på den.

Ingenting er løsere for en agent

Hver booking går gjennom den samme funksjonen som bookingsiden bruker. Åpningstider, fravær, varslingsfrist og bookingvindu sjekkes på nytt inne i transaksjonen som skriver. En tid som var ledig for et øyeblikk siden kan fortsatt bli avvist med «slot_taken» – det er systemet som virker.

Endepunkter

GET/businesses/{slug}The business and its booking rules
GET/businesses/{slug}/servicesWhat can be booked
GET/businesses/{slug}/staffWho works there, and what they do
GET/businesses/{slug}/availabilityFree slots for a service
POST/businesses/{slug}/bookingsMake a booking
GET/bookings/{manage_token}Read a booking
POST/bookings/{manage_token}/cancelCancel a booking

Konvensjoner

  • Tidspunkter er ISO 8601 med offset.
  • Beløp er heltall i minste enhet, pluss valutakode. 45000 NOK er 450 kroner.
  • Varighet er hele minutter.
  • Feil er alltid { error: { code, message } } med en dokumentert kode.

Et eksempel

Finn en ledig time og book den. Bytt ut slug-en med bedriftens egen.

# 1. What does this shop do?
curl https://www.clientlyapp.com/api/v1/businesses/studionord/services

# 2. When is it free?
curl "https://www.clientlyapp.com/api/v1/businesses/studionord/availability\
?service_id=SERVICE_ID&days=7"

# 3. Book the first free slot. Omit staff_id to let the shop
#    assign whoever has the fewest bookings that day.
curl -X POST https://www.clientlyapp.com/api/v1/businesses/studionord/bookings \
  -H "Content-Type: application/json" \
  -d '{
        "service_id": "SERVICE_ID",
        "starts_at": "2026-11-25T13:00:00.000Z",
        "name": "Ola Nordmann",
        "email": "ola@example.no"
      }'

# Keep the manage_token from the response: it is the only
# way back to the booking.
curl https://www.clientlyapp.com/api/v1/bookings/MANAGE_TOKEN

Feilkoder

validation_failed400The request body or query was not valid.
not_found404No such business, service or booking.
bookings_closed409This business is not taking online bookings.
slot_taken409That time is no longer free.
outside_booking_window409That time is further ahead than this business accepts.
below_minimum_notice409That time is sooner than this business accepts.
staff_unavailable409That person is not available then.
service_not_offered_by_staff409That person does not perform this service.
past_cutoff409This booking can no longer be cancelled online. Contact the business.
booking_state_final409This booking has already been cancelled, completed or marked as a no-show.
rate_limited429Too many requests. Slow down and try again.
internal_error500Something went wrong on our side.

Grenser

Per IP-adresse: lesing er romslig, booking er 5 i timen per bedrift. Et avslag er 429 med «Retry-After».

Hele beskrivelsen

OpenAPI 3.1, generert fra den samme feiltabellen endepunktene svarer med – så dokumentasjonen kan ikke komme ut av takt med oppførselen.

Åpne openapi.json