Developer Portal / Changelog & Versioning
Developer Portal

Changelog & Versioning

Track changes and updates to the eAgenda API. We follow semantic versioning to ensure compatibility and predictability.

Versioning

The API uses versioning in the URL:

https://eagenda.com.br/api/v3/

The current version is v3. Breaking changes result in a new major version (e.g., v4). Improvements and fixes are made within the current version without breaking existing integrations.

Compatibility policy

Within the same version, we guarantee:

  • Existing endpoints continue to work
  • Existing fields in responses are not removed
  • New fields may be added to responses (your integration should ignore unknown fields)
  • New endpoints may be added
  • New optional parameters may be added

What may change without notice

  • Order of fields in JSON responses
  • Addition of new optional fields
  • Addition of new enum values (e.g., new statuses)
  • Error messages (HTTP codes remain stable)

Best practices for durable integrations

  1. Ignore unknown fields — Don’t break if the API returns new fields
  2. Don’t depend on field order — Parse JSON by field name, not position
  3. Handle enums with a default — If an unknown status appears, handle it with a fallback
  4. Monitor this changelog — Subscribe to updates to stay informed about changes

Change history

June 2026

  • Developer Portal published with complete documentation
  • Added code examples in Python, JavaScript, PHP and C#

API v3 resources

Version 3 of the API includes the following resources:

  • Accounts — Full CRUD for accounts and sub-accounts
  • Calendars — Calendar management with appointment mode filters
  • Services — Service management with duration and price
  • Available times — Availability queries with multi-service support
  • Random time slots — Endpoint for suggesting random available times
  • Available days — Query days with availability in a period
  • Appointments — Full CRUD with rescheduling and 11 different statuses
  • People — Client management with search by ID, email, phone or external ID
  • Tags — Appointment classification
  • Access lists — Access control by client list
  • Forms — Custom forms linked to calendars
  • Webhooks — Real-time notifications via HTTP callbacks
  • Users — User and permission management
  • OpenAPI Schema — Complete specification available at /api/v3/schema/