Skip to content
Ordinus
Sign up free

Documentation

Everything you need to launch, customize, and integrate scheduling.

Product docs

Guides and tutorials for using Ordinus. Learn how to set up your account, manage appointments, and more.

Open help center

API docs
Pro

Complete API reference for developers. Build custom integrations and automate your scheduling workflow.

API reference

Pro feature

The Ordinus API is available to Pro plan users. All endpoints follow REST principles and return JSON.

Authentication

API requests are authenticated using API keys. Generate your API key from the Developer page in your account.

curl https://api.ordinus.io/v1/appointments \
  -H "Authorization: Bearer YOUR_API_KEY"

Keep your API keys secure and never commit them to version control.

Endpoints overview

GET
/v1/appointmentsList appointments
GET
/v1/appointments/:idGet appointment
POST
/v1/appointmentsCreate appointment
PATCH
/v1/appointments/:idUpdate appointment
DELETE
/v1/appointments/:idCancel appointment
GET
/v1/availabilityGet available slots

Example request

Create a new appointment with the API:

curl -X POST https://api.ordinus.io/v1/appointments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment_type_id": "apt_123",
    "start_time": "2024-01-15T10:00:00Z",
    "client": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }'

Example response

{
  "id": "appt_abc123",
  "appointment_type_id": "apt_123",
  "start_time": "2024-01-15T10:00:00Z",
  "end_time": "2024-01-15T11:00:00Z",
  "status": "confirmed",
  "client": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "created_at": "2024-01-10T14:30:00Z"
}

Error format

All errors follow a consistent format:

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: client.email",
    "param": "client.email"
  }
}

Common error codes: invalid_request, authentication_failed, rate_limit_exceeded, resource_not_found

Rate limits

API requests are rate limited to ensure service availability for all users:

  • 100 requests per minute per API key
  • 1,000 requests per hour per API key
  • Rate limit headers included in all responses

Contact support if you need higher rate limits for your use case.

Webhooks

Webhooks allow you to receive real-time notifications for events in your account. Configure endpoints in the Developer page.

Available events:

  • appointment.created - New appointment booked
  • appointment.updated - Appointment modified
  • appointment.cancelled - Appointment cancelled
  • payment.succeeded - Payment completed
  • payment.failed - Payment failed

Webhook requests include an X-Ordinus-Signature header for verification. Always verify signatures before processing webhook data.