List calendar events with filters (Admin)

Retrieve list of calendar events with optional filtering. Requires admin authentication.

GET

https://api.channelautomation.com/api/calendar/events

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header

Query parameters

workspace_id
optional
string
Filter by workspace ID
admin_id
optional
string
Filter by admin/creator ID
start_date
optional
string
Filter events from this date

format: date
end_date
optional
string
Filter events until this date

format: date

Returns

200

Events retrieved successfully

JSON

success
optional
boolean
events
optional
array of
object
- workspace_id
  string
  required
  Workspace ID
- start_time
  string
  required
  Start time of the appointment
  
  format: date-time
- end_time
  string
  required
  End time of the appointment
  
  format: date-time
- id
  optional
  string
  Unique identifier (for updates)
- contact_id
  optional
  string
  Associated contact ID
- admin_id
  optional
  string
  Admin/agent ID
- event_title
  optional
  string
  Title of the event/appointment
- event_description
  optional
  string
  Description of the event
- status
  optional
  string
  Status of the appointment
- location
  optional
  string
  Location of the appointment
- notes
  optional
  string
  Additional notes
}

401

Authentication required

JSON

error
optional
string
success
optional
boolean

403

Admin privileges required

JSON

error
optional
string
success
optional
boolean

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

List calendar events with filters (Admin)

curl --request GET \
  --url https://api.channelautomation.com/api/calendar/events \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.channelautomation.com/api/calendar/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "success": true,
  "events": [
    {
      "id": "appointment-uuid",
      "contact_id": "contact-uuid",
      "admin_id": "admin-uuid",
      "workspace_id": "workspace-uuid",
      "event_title": "Product Consultation",
      "event_description": "Initial consultation meeting",
      "start_time": "2025-07-15T09:00:00Z",
      "end_time": "2025-07-15T10:00:00Z",
      "status": "scheduled",
      "location": "Virtual Meeting",
      "notes": "Customer interested in kitchen renovation"
    }
  ]
}

{
  "error": "Authentication required",
  "success": false
}

{
  "error": "Admin privileges required",
  "success": false
}

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}