Home > Agendize Scheduling

Online Scheduling API Reference

On February 28th, 2018 we released the version 2.1 of the Online Scheduling API. This new version includes performance improvements and a better respect of HTTP protocol for RestFull APIs. All v2.0 URIs of the Online Scheduling API are available in v2.1. If you are currently using the v2.0 of the Online Scheduling API, we encourage you to update to the newer version. If needed, the previous version's documentation is still available here.

The Online Scheduling API empowers you to manage your business activities and to create online scheduling buttons to install through your web presence. This API reference is organized around several objects with a hierarchy and dependencies:

  1. Company/ies
    1. Their services or resources
    2. Their staff
  2. Appointments

Agendize Online Scheduling can be set up in one of two modes: service mode or resource mode. Thus, appointments can link a client with a service and a staff or a client with a resource.

To create clients, refer to the Clients CRM API reference.

Once you get your hands on those objects, you can experience further this API with the next objects: settings, widget and scheduling buttons.


Companies

Method HTTP Request Description
URIs relative to https://api.agendize.com/api/2.1, unless otherwise noted
delete DELETE /companies/{companyId} Deletes an entry on the user's company list.
get GET /companies/{companyId} Returns an entry of the user's company list.
list GET /companies Returns entries on the user's company list.
insert POST /companies Adds an entry to the user's company list.
update PUT /companies/{companyId} Updates an entry on the user's company list.

Services

Method HTTP Request Description
URIs relative to https://api.agendize.com/api/2.1, unless otherwise noted
delete DELETE /companies/{companyId}/services/{serviceId} Deletes an entry on the company's service list.
get GET /companies/{companyId}/services/{serviceId} Returns an entry of the company's service list.
list GET /companies/{companyId}/services Returns entries on the company's service list.
insert POST /companies/{companyId}/services Adds an entry to the company's service list.
update PUT /companies/{companyId}/services/{serviceId} Updates an entry on the company's service list.

Resources

Method HTTP Request Description
URIs relative to https://api.agendize.com/api/2.1, unless otherwise noted
delete DELETE /companies/{companyId}/resources/{resourceId} Deletes an entry on the company's resource list.
get GET /companies/{companyId}/resources/{resourceId} Returns an entry of the company's resource list.
list GET /companies/{companyId}/resources Returns entries on the company's resource list.
insert POST /companies/{companyId}/resources Adds an entry to the company's resource list.
update PUT /companies/{companyId}/resources/{resourceId} Updates an entry on the company's resource list.

Staff

Method HTTP Request Description
URIs relative to https://api.agendize.com/api/2.1, unless otherwise noted
delete DELETE /companies/{companyId}/staff/{staffId} Deletes an entry on the company's staff member list.
get GET /companies/{companyId}/staff/{staffId} Returns an entry of the company's staff member list.
list GET /companies/{companyId}/staff Returns entries on the company's staff member list.
insert POST /companies/{companyId}/staff Adds an entry to the company's staff member list.
update PUT /companies/{companyId}/staff/{staffId} Updates an entry on the company's staff member list.

Appointments

Method HTTP Request Description
URIs relative to https://api.agendize.com/api/2.1, unless otherwise noted
delete DELETE /companies/{companyId}/appointments/{appointmentId} Deletes an entry on the company's appointment list.
get GET /companies/{companyId}/appointments/{appointmentId} Returns an entry of the company's appointment list.
list GET /companies/{companyId}/appointments Returns entries on the company's appointment list.
insert POST /companies/{companyId}/appointments Adds an entry to the company's appointment list.
update PUT /companies/{companyId}/appointments/{appointmentId} Updates an entry on the company's appointment list.