Agendize Developers API

Agendize Resellers API

Appointments

{ "id": {string}, "reference": {string}, "company": { "id": {string}, "name": {string} }, "service": { "id": {string}, "name": {string}, "externalId": {string} }, "resource": { "id": {string}, "name": {string}, "externalId": {string} }, "staff": { "id": {string}, "firstName": {string}, "lastName": {string}, "externalId": {string} }, "client": { "id": {string}, "firstName": {string}, "lastName": {string}, "email": {string}, "phone": {string}, "mobilePhone": {string}, "externalId": {string}, "timeZone": {string} }, "parent": { "id": {string}, "firstName": {string}, "lastName": {string}, "email": {string}, "externalId": {string}, "timeZone": {string} }, "start": { "dateTime": {datetime}, "timeZone": {string} }, "end": { "dateTime": {datetime}, "timeZone": {string} }, "created": { "dateTime": {datetime}, "timeZone": {string} }, "form": [ {FormItem object} ], "status": {string}, "customStatus": { "id": {string}, "name": {string} }, "notes": {string}, "history": [ { "text": {string}, "date": { "dateTime": {datetime}, "timeZone": {string} }, "source": {string}, "user": { "firstName": {string}, "lastName": {string), "email": {string}, "userName": {string} }, "type": {string} } ], "service-resource": [ { "id": {string}, "name": {string} } ], "meta-event": {boolean}, "type": {string}, "paid": {boolean}, "addToWaitingList": {boolean}, "source": {string}, "iterationCount": {integer}, "sendto": {string}, "synchronization": { "googleCalendar": { "id": {string} }, "office365Calendar": { "id": {string} }, "windowsLiveCalendar": { "id": {string} }, "salesforce": { "id": {string} } }, "rescheduleLink": {string}, "onlineMeeting": { "provider": {string}, "videoLink: {string} }, "encryptedId": {string}, "price": { "amount": {float}, "currency": {string} }, "location": {string}, "locationCustom": {string}, "extendedProperties": { "private": {object}, "public": {object} } }
Notes
id string Identifier of the appointment. Read only.
reference string Reference code of the appointment.
company object company details.
company.id string Identifier of the company.
company.name string Name of the company.
service object Service details. Only if the appointment is for a service.
service.id string Identifier of the service. writable. Max length 16.
service.name string Name of the service.
service.externalId string Unique service identifier from another (external) system. writable only.
resource object Resource details. Only if the appointment is for a resource.
resource.id string Identifier of the resource. writable. Max length 16.
resource.name string Name of the resource.
resource.externalId string Unique resource identifier from another (external) system. writable only.
staff object Staff details.
staff.id string Identifier of the company's staff member. writable. Max length 16.
staff.firstName string First name of the company's staff member.
staff.lastName string Last name of the company's staff member.
staff.externalId string Unique staff member identifier from another (external) system. writable only.
client object Client details.
client.id string Identifier of the client. the id is unique and should not be reused for another account. writable. Max length 16.
client.firstName string First name of the client. writable. Max length 127.
client.lastName string Last name of the client. writable. Max length 127.
client.email string Email Address of the client. writable. Max length 127.
client.timeZone string Time zone of the client. Only if time zone has been specified. writable
client.externalId string Unique client identifier from another (external) system. writable. Max length 65535.
client.phone string Phone number of the client.
client.mobilePhone string Mobile phone number of the client.
parent object For an appointment for someone else, details of the client who take the appointment.
parent.id string Identifier of the parent. the id is unique and should not be reused for another account. writable. Max length 16.
parent.firstName string First name of the parent. writable. Max length 127.
parent.lastName string Last name of the parent. writable. Max length 127.
parent.email string Email Address of the parent. writable. Max length 127.
parent.externalId string Unique parent identifier from another (external) system. writable. Max length 65535.
parent.timeZone string Time zone of the parent. Only if time zone has been specified. writable
start object The start time of the event. writable
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
end object The end time of the event. writable
end.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
end.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
created object Creation time of the event. Read-only.
form object The filled form of the event, see description below writable
status string The native status of the event. Values: "completed", "noShow", "accepted", "pending", "declined", "cancelled", "inProgress". writable
customStatus object The custom status of the event. Managed with the appointment statuses api. "status" and "customStatus" cannot be used in the same time. writable
customStatus.id string The identifier of the custom status. writable
customStatus.name string The name of the custom status. read-only
notes string Notes of the appointment. writable. Max length 65535.
history list Historic of updates on an appointment
history[] object History entry
history[].text string Status of the appointment
history[].date object Date of the appointment
history[].date.dateTime datetime Date of the appointment relative to the company time
history[].date.timeZone string Timezone related to the appointment date
history[].source string In the case of external cancellation, the source contains the cancellation's origin
history[].type string Type of change. Values: :
  • "booked"
  • "pending"
  • "accepted"
  • "finished"
  • "no_show"
  • "user_deleted"
  • "archived"
  • "in_progress"
  • "completed"
  • "declined"
  • "client_deleted"
  • "payment"
  • "changed_end"
  • "changed_service"
  • "started"
  • "user_rescheduled"
  • "user_rescheduled_changed_start"
  • "user_rescheduled_changed_staff"
  • "user_rescheduled_changed_resource"
  • "user_rescheduled_changed_client"
  • "user_rescheduled_changed_note"
  • "user_rescheduled_changed_field"
  • "client_rescheduled"
  • "client_rescheduled_changed_start"
  • "client_rescheduled_changed_staff"
  • "client_rescheduled_changed_resource"
  • "client_rescheduled_changed_client"
  • "client_rescheduled_changed_note"
  • "client_rescheduled_changed_field"
history[].user object Client concerned by the appointment
history[].user.firstName string Client's firstname
history[].user.lastName string Client's lastname
history[].user.email string Client's email
history[].user.userName string Client's login
type string The type of the event. Values: "normal" (appointment with a client) or "personal" (personal appointment). writable
paid string "true" if the appointment has been paid. writable
addToWaitingList string If "true", add the client to the waiting list. writable
iterationCount string Only for resource mode. Number of iterations. For insert/update only. writable
sendto string In case of an appointment for someone else, set if emails and text messages have to be sent to parent or client. Values: "parent", "client".
service-resource list List of service-resource details. Only if the appointment is for a service-resource.
service-resource.id string Id of the service-resource
service-resource.name string Name of the service-resource
meta-event boolean "true" if the appointment is meta event.
synchronization object Calendar and CRM synchronization data if the appoiment has been synchronized with each service.
googleCalendar object Google Calendar informations.
googleCalendar.id string Id of the event in Google Calendar.
office365Calendar object Office 365 Calendar informations.
office365Calendar.id string Id of the event in Office 365 Calendar.
windowsLiveCalendar object Windows Live Calendar informations.
windowsLiveCalendar.id string Id of the event in Windows Live Calendar.
salesforce object Salesforce informations.
salesforce.id string Id of the event in Salesforce.
rescheduleLink object Link to the reschedule page. Only if the appointment end is in futur. A finished appointment can't be rescheduled.
source string Source of the appointment. Free text.
onlineMeeting object Video conference link and provider.
onlineMeeting.provider string Provider of the video conference. Values: "agendize", "teams".
onlineMeeting.videoLink string Web link to the video conference.
encryptedId string Encrypted identifier of the appointment. Read only.
price object Price informations of the appointments. Only if the service has a price. Read-only.
price.amount float Price amount of the event.
price.currency string Currency of the company. Values: "USD", "CAD", "EUR", "GBP", "DKK", "JPY", "INR", "CNY", "MXN", "CHF", "NZD"
location string Localization of the appointment. Values: "companyAddress", "videoconference", "phone", "custom". Default: "companyAddress". writable
locationCustom string Custom localization of the appointment. Read only
extendedProperties object Extended Properties. You can defined your custom properties. Size limit: 22KB.
extendedProperties.private object Private properties. These properties are not retrieve in widget.
extendedProperties.public object Private properties. These properties are retrieve in widget.

Get

Return a specific appointment belonging to one of all companies of resellers's account.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/resellers/scheduling/appointments/{appointmentId}

Parameters

Parameter name Value Description
Path parameters
appointmentId string Appointment identifier or appointment reference.
Optional query parameters
lang string Language use to retreive appointment history strings.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an Appointment resource in the response body.

List

Returns appointment entries on all companies of resellers's account.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/resellers/scheduling/appointments

Parameters

Parameter name Value Description
Optional query parameters
startDate datetime Upper bound (exclusive) for an appointment's start time (as a RFC 3339 timestamp) in GMT to filter by. Optional. The default value is now -1 month.
endDate datetime Lower bound (exclusive) for an appointment's end time (as a RFC 3339 timestamp) in GMT to filter by. Optional. The default value is now +1 month.
createdStartDate datetime Upper bound (exclusive) for an appointment's creation time (as a RFC 3339 timestamp) in GMT to filter by. Optional. The default is not to filter by creation time.
createdEndDate datetime Lower bound (exclusive) for an appointment's creation time (as a RFC 3339 timestamp) in GMT to filter by. Optional. The default is not to filter by creation time.
clientExternalId string Unique client identifier from another (external) system.
showDeleted boolean Whether to include deleted appointment list entries in the result. Optional. The default is false.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a list of Appointment resource in the response body.

{ items: [Appointment Resource] }

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.