---
title: "Return a list of custome fields."
method: GET
path: "/custom-fields"
tags: ["Custom fields"]
---

# Return a list of custome fields.

`GET /custom-fields`

Returns a list of the existing custom fields in Kenjo.

## Query parameters

- `section` 'personal' | 'work' | 'address' | 'financial' | 'home'
- `label` string
- `apiName` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` object[]
    - `_id` string — The Kenjo _id of the custom field.
    - `section` string — The name of custom field section.
    - `label` string — The name of custom field label.
    - `apiName` string — The api name is a required identifier to perform POST and PUT operations with employees.
    - `type` string — The data type of the custom field. Possible values "Text", "TextArea", "List", "Date", "Number", "Email", "Boolean" and "Url"
    - `values` string[] — If the field is type 'List' then a list with the possible values will be provided.

## Other responses

- `400` — BAD REQUEST. This is a wrong request in the client side due to invalid body or params.
- `401` — UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

---

[API](https://skmtc.net/kenjo/apis/kenjo-api.md) · [All operations](https://skmtc.net/kenjo/apis/kenjo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kenjo/kenjo-api/revisions/58772b78268e/schema)