Developer Portal / Getting Started
Developer Portal

Getting Started

This guide will help you make your first call to the eAgenda API in just a few minutes.

Overview

The eAgenda REST API lets you integrate online scheduling features into any system. With it, you can:

  • Create and manage appointments programmatically
  • Check available time slots in real time
  • Manage clients, calendars and services
  • Receive notifications via webhooks when events occur

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

1. Get your credentials

To use the API, you need an access token:

  1. Log in to the eAgenda dashboard
  2. Go to Settings > Integrations > API
  3. Click Generate API Token
  4. Copy the generated token — it will only be shown once

Important: Keep your token in a safe place. Never expose it in public source code or in your application’s frontend.

2. Make your first request

With your token ready, test it by listing your accounts:

curl -X GET https://eagenda.com.br/api/v3/accounts/ \
  -H "Authorization: Basic YOUR_BASE64_TOKEN"

Authentication uses HTTP Basic Auth. The token must be Base64-encoded in the format username:password.

Example response

{
  "count": 1,
  "results": [
    {
      "account_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "My Company",
      "slug": "my-company",
      "is_active": true
    }
  ]
}

3. Understand the API structure

Main resources

ResourceEndpointDescription
Accounts/api/v3/accounts/Manage accounts and sub-accounts
Calendars/api/v3/calendars/Manage calendars
Services/api/v3/services/Manage offered services
Time Slots/api/v3/available-date-times/Check availability
Appointments/api/v3/appointments/Create and manage appointments
People/api/v3/people/Manage clients/people
Tags/api/v3/tags/Classify appointments
Webhooks/api/v3/webhooks/Receive event notifications
Users/api/v3/users/Manage account users

Pagination

All list endpoints return paginated results:

{
  "count": 150,
  "next": "https://eagenda.com.br/api/v3/appointments/?page=2",
  "previous": null,
  "results": [...]
}

Use the page and page_size parameters to navigate between pages.

Response format

  • All responses are in JSON
  • Dates follow the ISO 8601 format (2026-06-04T14:30:00-03:00)
  • Unique identifiers use the UUID format (a1b2c3d4-e5f6-7890-abcd-ef1234567890)

4. Next steps

  • Authentication — Understand authentication methods and how to protect your credentials
  • Create an appointment — Step-by-step tutorial for creating your first appointment via API
  • List available times — How to check calendar availability
  • Interactive reference — Test endpoints directly in the browser on the API Reference page

Example repository

We provide a GitHub repository with ready-to-use integration examples:

GitHub: mupisystems/eagenda-integracao