| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.agendize.com/api/2.0 | link | — | — | — |
Actions (103)
Scheduling · 20
- Create appointmentPOST /api/2.0/companies/{companyId}/appointments
Create a new appointment for a company.
documented - Create companyPOST /api/2.0/companies
Create a new company in the account.
documented - Delete appointmentDELETE /api/2.0/companies/{companyId}/appointments/{appointmentId}
Delete an appointment for a company.
documented - Delete appointmentDELETE /api/2.0/scheduling/companies/{companyId}/appointments/{appointmentId}
Delete an appointment for a company.
documented - Delete companyDELETE /api/2.0/companies/{companyId}
Delete a company from the scheduling data.
documented - Fetch free slotsGET /api/2.1/scheduling/companies/{companyId}/widget/freeSlots
Get available time slots for a service/resource over a date range.
documented - Fetch next slotsGET /api/2.1/scheduling/companies/{companyId}/widget/nextSlots
Get upcoming available time slots for a service/resource.
documented - Get appointmentGET /api/2.0/companies/{companyId}/appointments/{appointmentId}
Retrieve a specific appointment for a company.
documented - Get companyGET /api/2.0/companies/{companyId}
Retrieve a single company entry.
documented - Get external appointmentGET /api/2.1/scheduling/companies/{companyId}/externalAppointments/{appointmentId}
Retrieve a specific external appointment.
documented - List appointmentsGET /api/2.0/companies/{companyId}/appointments
List appointments for a company with optional filters.
documented - List companiesGET /api/2.0/companies
List all companies in the account.
documented - List external appointmentsGET /api/2.1/scheduling/companies/{companyId}/externalAppointments
List external appointments for a company.
documented - List external appointmentsGET /api/2.0/companies/{companyId}/externalAppointments
List external appointments for a company.
documented - List notificationsGET /api/2.1/scheduling/companies/{companyId}/notifications
List notification rules/messages for a company.
documented - Update appointmentPUT /api/2.0/companies/{companyId}/appointments/{appointmentId}
Update an existing appointment.
documented - Update companyPUT /api/2.0/companies/{companyId}
Update an existing company.
documented - Watch appointmentsGET /api/2.1/scheduling/appointments/watch
Watch for appointment changes.
documented - Watch appointmentsPOST /api/2.0/companies/{companyId}/appointments/watch
Watch for changes to appointment resources.
documented - Watch notificationsPOST /api/2.1/scheduling/companies/{companyId}/notifications/watch
Watch for email/SMS notifications and reminders.
documented
Clients · 13
- Add client notePOST /api/2.3/clients/{clientId}/notes
Add a note to a client.
documented - Create clientPOST /api/2.3/clients
Create a new client.
documented - Delete clientDELETE /api/2.3/clients/{clientId}
Delete a client.
documented - Get clientGET /api/2.3/clients/{clientId}
Retrieve a client by id.
documented - Get client noteGET /api/2.3/notes/{noteId}
Retrieve a note for a client.
documented - Get client settingsGET /api/2.3/clients/{clientId}/settings
Get settings for a client.
documented - List client activitiesGET /api/2.3/activities
List activities for a client.
documented - List client tagsGET /api/2.3/clients/{clientId}/tags
List tags for a client.
documented - List clientsGET /api/2.3/clients
List clients.
documented - Merge clientsPOST /api/2.3/clients/merge
Merge two client records.
documented - Patch clientPUT /api/2.3/clients/{clientId}
Partially update a client.
documented - Update clientPUT /api/2.3/clients/{clientId}
Update a client.
documented - Watch clientsGET /api/2.3/clients/watch
Watch for client resource changes.
documented
Forms · 12
- Create formPOST /api/2.3/forms
Create a form.
documented - Create result statusPOST /api/2.3/status
Create a result status.
documented - Delete formDELETE /api/2.3/forms/{formId}
Delete a form.
documented - Delete resultDELETE /api/2.3/results/{resultId}
Delete a form result.
documented - Get formGET /api/2.3/forms/{formId}
Retrieve a form.
documented - Get resultGET /api/2.3/results/{resultId}
Get a form result.
documented - List form resultsGET /api/2.3/results
List results for a form.
documented - List formsGET /api/2.3/forms
List forms.
documented - List result statusesGET /api/2.3/status
List result statuses.
documented - Submit form resultPOST /api/2.3/results
Submit a form result.
documented - Update formPUT /api/2.3/forms/{formId}
Update a form.
documented - Update resultPUT /api/2.3/results/{resultId}
Update a form result.
documented
Queues · 10
- Add registrationPOST /api/2.0/registrations
Add a person to a queue.
documented - Advance registrationPUT /api/2.0/registrations/next
Move to next in line.
documented - Create queuePOST /api/2.0/queues
Create a queue.
documented - Delete queueDELETE /api/2.0/queues/{queueId}
Delete a queue.
documented - Get queueGET /api/2.0/queues/{queueId}
Retrieve a queue.
documented - Get registrationGET /api/2.0/registrations/{registrationId}
Get a registration.
documented - List queuesGET /api/2.0/queues
List queues.
documented - List registrationsGET /api/2.0/registrations
List registrations for queues.
documented - Update queuePUT /api/2.0/queues/{queueId}
Update a queue.
documented - Update registrationPUT /api/2.0/registrations/{registrationId}
Update a queue registration.
documented
Reseller · 7
- Create reseller accountPOST /api/2.0/resellers/accounts
Create a reseller account.
documented - Delete reseller accountDELETE /api/2.0/resellers/accounts/{accountId}
Delete a reseller client account.
documented - Get reseller accountGET /api/2.0/resellers/accounts/{accountId}
Get a reseller account.
documented - Get reseller scheduling settingsGET /api/2.0/resellers/settings/scheduling
Get reseller scheduling settings.
documented - List reseller accountsGET /api/2.0/resellers/accounts
List reseller accounts.
documented - Update reseller accountPUT /api/2.0/resellers/accounts/{accountId}
Update reseller account.
documented - Update reseller scheduling settingsPUT /api/2.0/resellers/settings/scheduling
Update reseller scheduling settings.
documented
Calls · 6
- Create callPOST /api/2.0/calls
Create a new call record.
documented - Delete callDELETE /api/2.0/calls/{callId}
Delete a call.
documented - Get callGET /api/2.0/calls/{callId}
Retrieve a single call.
documented - List callsGET /api/2.0/calls
List call records.
documented - Update callPUT /api/2.0/calls/{callId}
Update a call record.
documented - Watch callsPOST /api/2.0/calls/watch
Watch for call updates.
documented
Conferences · 6
- Create conferencePOST /conferences/api/1.0/conferences
Create a conference.
documented - Delete conferenceDELETE /conferences/api/1.0/conferences/{conferenceId}
Delete a conference.
documented - Get conferenceGET /conferences/api/1.0/conferences/{conferenceId}
Get a conference.
documented - List conferencesGET /conferences/api/1.0/conferences
List conferences.
documented - List speakersGET /conferences/api/1.0/conferences/{conferenceId}/speakers
List conference speakers.
documented - Update conferencePUT /conferences/api/1.0/conferences/{conferenceId}
Update a conference.
documented
Email Marketing · 6
- Create email templatePOST /api/2.0/messages/emails/templates
Create a new email template.
documented - Delete email templateDELETE /api/2.0/messages/emails/templates/{templateId}
Delete an email template.
documented - Get email templateGET /api/2.0/messages/emails/templates/{templateId}
Retrieve an email template.
documented - List email templatesGET /api/2.0/messages/emails/templates
List all email templates.
documented - Send emailPOST /api/2.0/messages/emails/send
Send marketing email to recipients.
documented - Update email templatePUT /api/2.0/messages/emails/templates/{templateId}
Update an email template.
documented
SMS Marketing · 6
- Create SMS templatePOST /api/2.0/messages/sms/templates
Create an SMS template.
documented - Delete SMS templateDELETE /api/2.0/messages/sms/templates/{templateId}
Delete an SMS template.
documented - Get SMS templateGET /api/2.0/messages/sms/templates/{templateId}
Retrieve an SMS template.
documented - List SMS templatesGET /api/2.0/messages/sms/templates
List SMS templates.
documented - Send SMSPOST /api/2.0/messages/sms/send
Send marketing SMS to recipients.
documented - Update SMS templatePUT /api/2.0/messages/sms/templates/{templateId}
Update an SMS template.
documented