Use this endpoint to return a locations Appointment Custom Field definitions. Appointment custom fields are stored with each appointment. They are used when the information collected during the booking is specific to a particular appointment/visit. The response will list the custom fields used (customField1 - 10), the field type (string, number, date, boolean) and the length of each one.
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 Custom Fields List
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
{
"type": "object",
"properties": {
"locationId": {
"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
{
"type": "object",
"properties": {
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldKey": {
"type": "string"
},
"fieldLabel": {
"type": "string"
},
"fieldLength": {
"type": "integer",
"format": "int32"
},
"fieldListItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"leadAnswerScore": {
"type": "integer",
"format": "int32"
},
"leadRoutingEntityId": {
"type": "integer",
"format": "int32"
},
"leadRoutingEntityType": {
"type": "string"
},
"name": {
"type": "string"
},
"object": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"fieldName": {
"type": "string"
},
"fieldPublic": {
"type": "boolean"
},
"fieldRequired": {
"type": "boolean"
},
"fieldType": {
"type": "string"
},
"id": {
"type": "string"
},
"leadQuestion": {
"type": "boolean"
},
"leadQuestionWeight": {
"type": "number",
"format": "double"
},
"object": {
"type": "string"
},
"sortKey": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"object": {
"type": "string"
},
"total": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}