action onsched_get_consumer_v1_appointments_bookingfields { label: "Get Custom Fields Labels" description: "
Use this endpoint to return a locations Appointment Booking Fields. Appointment booking fields are stored with each Appointment record. They are used when you need additional information collected during your booking process. It is tied to an appointment/visit and will be stored in the appointment record. Use the field name, type, and length to determine how to update these field values when posting an appointment.
" provider: onsched method: GET path: "/consumer/v1/appointments/bookingfields" encoding: json input: { type: "object" properties: { locationId: { type: "string" } } additionalProperties: false } output: { type: "object" properties: { bookingFields: { type: "array" items: { type: "object" properties: { businessId: { type: "string" } companyId: { 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" } 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 } }