How do I authenticate?

Use OAuth2 client credentials to obtain a short-lived access token with the scopes you need (e.g., availability:read, appointments:write).

How are conflicts prevented?

Availability and booking endpoints respect holds and scheduled appointments, reusing Zimun’s internal conflict detection.

Zimun RSVP Platform: API Reference

Machine-readable OpenAPI plus a quick overview of authentication and key endpoints.

Authentication

Use OAuth2 Client Credentials to obtain short-lived access tokens. Tokens must include scopes relevant to the endpoints (e.g., availability:read, appointments:write).

Download OpenAPI (YAML)

Live OpenAPI View

Rendered with Swagger UI directly from the same YAML.

Base URL

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

Key Endpoints

GET /organizations/me — organization profile
GET /services, /staff, /resources
GET /availability — slots per service/staff/date
POST /appointments/hold — create a 10-minute hold
DELETE /holds/{hold_id} — release hold
POST /appointments — confirm appointment using hold_id
PATCH /appointments/{id} — reschedule or cancel