| Parameter name | Value | Description | Notes |
|---|---|---|---|
id |
string |
Identifier of the appointment. | |
reference |
string |
Rerefence 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 |
service.name |
string |
Name of the service. | |
resource |
object |
Resource details. Only if the appointment is for a resource. | |
resource.id |
string |
Identifier of the resource. | writable |
resource.name |
string |
Name of the resource. | |
staff |
object |
Staff details. | |
staff.id |
string |
Identifier of the company's staff member. | writable |
staff.firstName |
string |
First name of the company's staff member. | |
staff.lastName |
string |
Last name of the company's staff member. | |
client |
object |
Client details. | |
client.id |
string |
Identifier of the client. the id is unique and should not be reused for another account. | writable |
client.firstName |
string |
First name of the client. | writable |
client.lastName |
string |
Last name of the client. | writable |
client.email |
string |
Email Address of the client. | writable |
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 |
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 |
parent.firstName |
string |
First name of the parent. | writable |
parent.lastName |
string |
Last name of the parent. | writable |
parent.email |
string |
Email Address of the parent. | writable |
parent.externalId |
string |
Unique parent identifier from another (external) system. | writable |
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. | writable |
form[].id |
string |
Identifier of the field | |
form[].title |
string |
Title of the field | |
form[].value |
string |
Value of the field. For get and list methods and a file field type it is the link to the file. For insert and update methods it is the data URI scheme binary content of the file. | writable |
status |
string |
The status of the event. Values: "completed", "noShow", "accepted", "pending", "declined", "cancelled", "inProgress". | writable |
notes |
string |
Notes of the appointment. | writable |
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 |
location |
string |
Localization of the appointment. Values: "companyAddress", "videoconference", "phone", "custom". Default: "companyAddress". writable | |
locationCustom |
string |
Custom localization of the appointment. Read only |
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.
| 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. |
Do not supply a request body with this method.
If successful, this method returns an Appointment resource in the response body.
Returns appointment entries on all companies of resellers's account.
Authentication is required to execute this request. Please refer to Authentication for more.
| 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. |
Do not supply a request body with this method.
If successful, this method returns a list of Appointment resource in the response body.