---
title: "Get Custom Fields Labels"
method: GET
path: "/consumer/v1/appointments/bookingfields"
tags: ["Appointments"]
---

# Get Custom Fields Labels

`GET /consumer/v1/appointments/bookingfields`

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.

## Query parameters

- `locationId` string

## Response `200`

Success

- BookingFieldListViewModel
  - `object` string, nullable
  - `total` integer
  - `bookingFields` BookingFieldViewModel[], nullable
    - `object` string, nullable
    - `id` string, nullable
    - `companyId` string, nullable
    - `businessId` string, nullable
    - `fieldName` string, nullable
    - `fieldLabel` string, nullable
    - `fieldRequired` boolean
    - `fieldLength` integer
    - `fieldType` string, nullable
    - `sortKey` integer
    - `leadQuestion` boolean
    - `leadQuestionWeight` number, double
    - `fieldListItems` BookingFieldListItemViewModel[], nullable
      - `object` string, nullable
      - `id` string, nullable
      - `name` string, nullable
      - `value` string, nullable
      - `leadAnswerScore` integer
      - `leadRoutingEntityType` string, nullable
      - `leadRoutingEntityId` integer

---

[API](https://skmtc.net/onsched/apis/onsched-consumer-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-consumer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-consumer-api/versions/1cd2a28a0305/schema)