Use this endpoint to return a List of Appointments. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. For more information:
643 matches
38 actions
OnSched Consumer
38 actions
- Book AppointmentPUTv1.0.0
- Cancel AppointmentPUTv1.0.0
- Confirm AppointmentPUTv1.0.0
- Create AppointmentPOSTv1.0.0
- Create CustomerPOSTv1.0.0
- Delete AppointmentDELETEv1.0.0
- Delete CustomerDELETEv1.0.0
- Get AppointmentGETv1.0.0
- Get AppointmentsGETv1.0.0
- Get Available DaysGETv1.0.0
- Get Available TimesGETv1.0.0
- Get Custom Fields LabelsGETv1.0.0
- Get Custom Fields ListGETv1.0.0
- Get CustomerGETv1.0.0
- Get Customer Booking FieldsGETv1.0.0
- Get Customer Custom FieldsGETv1.0.0
- Get LocationGETv1.0.0
- Get ResourceGETv1.0.0
- Get Resource GroupGETv1.0.0
- Get Resource Linked ServicesGETv1.0.0
- Get ServiceGETv1.0.0
- Get Service AllocationGETv1.0.0
- Get Service GroupGETv1.0.0
- Get Unavailable TimesGETv1.0.0
- List Country CodesGETv1.0.0
- List Country StatesGETv1.0.0
- List CustomersGETv1.0.0
- List LocationsGETv1.0.0
- List Resource GroupsGETv1.0.0
- List ResourcesGETv1.0.0
- List Resources for ServiceGETv1.0.0
- List Service AllocationsGETv1.0.0
- List Service GroupsGETv1.0.0
- List ServicesGETv1.0.0
- Reschedule AppointmentPUTv1.0.0
- Reserve AppointmentPUTv1.0.0
- Set NoShow StatusPUTv1.0.0
- Update CustomerPUTv1.0.0
Other/OnSched Consumer
Get Appointments
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
{
"type": "object",
"properties": {
"bookedBy": {
"type": "string"
},
"calendarId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"email": {
"type": "string"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"lastname": {
"type": "string"
},
"limit": {
"type": "integer",
"format": "int32"
},
"locationId": {
"type": "string"
},
"offset": {
"type": "integer",
"format": "int32"
},
"phone": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"serviceAllocationId": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
}
},
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"auditTrail": {
"type": "array",
"items": {
"type": "object",
"properties": {
"appointmentId": {
"type": "string"
},
"id": {
"type": "string"
},
"modificationType": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"modifiedOn": {
"type": "string"
},
"notesAfter": {
"type": "string"
},
"notesBefore": {
"type": "string"
},
"statusAfter": {
"type": "string"
},
"statusBefore": {
"type": "string"
}
},
"additionalProperties": false
}
},
"bookedBy": {
"type": "string"
},
"businessName": {
"type": "string"
},
"calendarId": {
"type": "string"
},
"confirmationNumber": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"createDate": {
"type": "string"
},
"customFields": {
"type": "object"
},
"customerId": {
"type": "string"
},
"customerMessage": {
"type": "string"
},
"customers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"appointmentId": {
"type": "string"
},
"customerId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"date": {
"type": "string"
},
"dateInternational": {
"type": "string"
},
"downloadIcsUrl": {
"type": "string"
},
"duration": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string"
},
"emailConfirmationSent": {
"type": "string"
},
"emailReminderSent": {
"type": "string"
},
"endDateTime": {
"type": "string"
},
"firstname": {
"type": "string"
},
"groupSize": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"lastModifiedBy": {
"type": "string"
},
"lastModifiedOn": {
"type": "string"
},
"lastname": {
"type": "string"
},
"latitude": {
"type": "string"
},
"location": {
"type": "string"
},
"locationId": {
"type": "string"
},
"longitude": {
"type": "string"
},
"name": {
"type": "string"
},
"notes": {
"type": "string"
},
"object": {
"type": "string"
},
"onlineBooking": {
"type": "boolean"
},
"paymentStatus": {
"type": "integer",
"format": "int32"
},
"phone": {
"type": "string"
},
"phoneExt": {
"type": "string"
},
"phoneType": {
"type": "string"
},
"rescheduledId": {
"type": "string"
},
"resourceEmail": {
"type": "string"
},
"resourceGroupId": {
"type": "string"
},
"resourceGroupName": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"resourceImageUrl": {
"type": "string"
},
"resourceName": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"appointmentId": {
"type": "string"
},
"resourceEmail": {
"type": "string"
},
"resourceGroupId": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"resourceImageUrl": {
"type": "string"
},
"resourceName": {
"type": "string"
}
},
"additionalProperties": false
}
},
"serviceAllocationId": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"serviceImageUrl": {
"type": "string"
},
"serviceName": {
"type": "string"
},
"smsConfirmationSent": {
"type": "string"
},
"smsReminderSent": {
"type": "string"
},
"startDateTime": {
"type": "string"
},
"status": {
"type": "string"
},
"stripeChargeId": {
"type": "string"
},
"stripeRefundId": {
"type": "string"
},
"time": {
"type": "integer",
"format": "int32"
},
"timezone": {
"type": "integer",
"format": "int32"
},
"timezoneIana": {
"type": "string"
},
"timezoneId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"object": {
"type": "string"
},
"total": {
"type": "integer",
"format": "int32"
},
"url": {
"type": "string"
}
},
"additionalProperties": false
}