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

# Get Custom Fields List

`GET /consumer/v1/appointments/customfields`

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.

## Query parameters

- `locationId` string

## Response `200`

Success

- CustomFieldDefinitionListViewModel
  - `object` string, nullable
  - `total` integer
  - `customFields` CustomFieldDefinitionViewModel[], nullable
    - `object` string, nullable
    - `id` string, nullable
    - `fieldKey` string, nullable
    - `fieldName` string, nullable
    - `fieldLabel` string, nullable
    - `fieldLength` integer
    - `fieldType` string, nullable
    - `sortKey` integer
    - `fieldPublic` boolean
    - `fieldRequired` boolean
    - `leadQuestion` boolean
    - `leadQuestionWeight` number, double
    - `fieldListItems` CustomFieldListDefinitionViewModel[], 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)