action onsched_get_consumer_v1_customers_bookingfields { label: "Get Customer Booking Fields" description: "
Use this endpoint to return Customer Booking Fields. Customer booking fields are stored with each customer object. They are used when the information collected during the booking is for a particular customer. Customer Booking Fields include any custom customer fields you define and want to capture with the Booking.
" provider: onsched method: GET path: "/consumer/v1/customers/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 } }