Zimun: Appointment Scheduling & Booking Software: API Guide

Zimun: Appointment Scheduling & Booking Software’s API is built for teams who want booking to feel seamless inside their own tools. Use it to show live availability, place temporary holds, and confirm appointments without conflicts.

Who this API is for

If you run a customer app, staff portal, or internal operations tool, the API lets you keep scheduling logic in sync with Zimun: Appointment Scheduling & Booking Software while still owning the experience.

Think of it as a scheduling engine you can embed anywhere: your website, your mobile app, or a private admin tool for your team.

Protocol & format

• HTTPS + JSON responses (UTF-8).
• OAuth2 Client Credentials authentication (RFC 6749 §4.4).
• Idempotent POST/PATCH with Idempotency-Key for safe retries.
• Pagination via page_size/page_token with { items, next_page_token }.
• ISO-8601 timestamps with timezone offsets.

How authentication works

1. Create an API client in Settings → API Clients to get your client_id and client_secret.
2. Request a token from /oauth/token using the client credentials grant.
3. Call the API with Authorization: Bearer <token>.

Tokens are short-lived and scoped to your organization.

Scopes at a glance

• org:read - organization metadata
• availability:read - slots and holiday map
• appointments:read - list/view appointments
• appointments:write - holds, confirm, reschedule, cancel, webhooks

Base URL

https://api.zimun.online/api/v1

Common booking flow

1. Show availability for a service or team member.
2. Create a 10-minute hold when a user picks a slot.
3. Confirm the appointment with customer details - or release the hold if they cancel.

This flow mirrors what the public booking page does, so you get the same conflict‑free behavior.

Quick example (cURL)

Use this example to fetch availability for the next 7 days. Replace the service_id and your access token.

curl -X GET \
  "https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

For end‑to‑end examples in Python, Node.js, Go, and Rust, see the API Reference page.

Typical use cases

• Embedded booking - Use the API to power a custom scheduling UI inside your app.
• CRM / POS sync - Push confirmed appointments to your internal tools or analytics stack.
• Operations dashboard - Query services, staff, and resources for a real-time schedule view.

User stories

• A clinic app shows available therapists per service, places holds while a patient fills a form, then confirms the appointment.
• A studio syncs appointments into its BI dashboard with a nightly pull.
• A SaaS marketplace embeds a booking modal that uses Zimun: Appointment Scheduling & Booking Software availability and conflict rules.