action onsched_get_consumer_v1_appointments_customfields { label: "Get Custom Fields List" description: "

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.

" provider: onsched method: GET path: "/consumer/v1/appointments/customfields" encoding: json input: { type: "object" properties: { locationId: { type: "string" } } additionalProperties: false } output: { 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 } }