API Documentation
Learn how to integrate your systems with SimplySchedule
Getting Started
To use the SimplySchedule API, you'll need an API key. You can generate one in your dashboard.
Authentication
All requests must include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYEndpoints
Appointments
GET
/api/appointmentsGet all appointments for the authenticated user.
Response
[
{
"_id": "507f1f77bcf86cd799439011",
"title": "Meeting with Client",
"startTime": "2023-05-20T14:00:00Z",
"endTime": "2023-05-20T15:00:00Z",
"attendees": [
{
"name": "John Doe",
"email": "john@example.com"
}
],
"location": "Office",
"description": "Discuss project timeline",
"status": "confirmed",
"createdAt": "2023-05-15T10:30:00Z",
"updatedAt": "2023-05-15T10:30:00Z"
}
]POST
/api/appointmentsCreate a new appointment.
Request Body
{
"title": "Meeting with Client",
"startTime": "2023-05-20T14:00:00Z",
"endTime": "2023-05-20T15:00:00Z",
"attendees": [
{
"name": "John Doe",
"email": "john@example.com"
}
],
"location": "Office",
"description": "Discuss project timeline"
}