---
title: "Get Customer Custom Fields"
method: GET
path: "/consumer/v1/customers/customfields"
tags: ["Customers"]
---

# Get Customer Custom Fields

`GET /consumer/v1/customers/customfields`

Use this endpoint to return **Customer Custom Fields**. Customer custom fields are stored with the customer object. They are used when the information collected during the booking is specific to a particular customer.

## Query parameters

- `locationId` string
- `leadQuestions` boolean

## 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)