---
title: "Gets a Custom Field by name"
method: GET
path: "/CustomFields/{objectName}/Search"
tags: ["CustomFields"]
---

# Gets a Custom Field by name

`GET /CustomFields/{objectName}/Search`

## Request

- Base URL: `https://api.insightly.com/v3.1`
- URL: `https://api.insightly.com/v3.1/CustomFields/{objectName}/Search`
- Auth: none declared. Required headers: `Authorization`

This read only endpoint returns a custom field by name.

## Path parameters

- `objectName` string, required

## Query parameters

- `fieldName` string, required

## Headers

- `Authorization` string, required

## Response `200`

Request succeeded.

- object
  - `FIELD_NAME` string, required
  - `FIELD_ORDER` integer, required
  - `FIELD_FOR` string, required
  - `FIELD_LABEL` string, required
  - `FIELD_TYPE` string, required
  - `FIELD_HELP_TEXT` string
  - `DEFAULT_VALUE` string
  - `EDITABLE` boolean
  - `VISIBLE` boolean
  - `CUSTOM_FIELD_OPTIONS` APICustomFieldOption[]
    - `OPTION_ID` integer
    - `OPTION_VALUE` string, required
    - `OPTION_DEFAULT` boolean, required
  - `DEPENDENCY` APICustomFieldDependency
    - `CONTROLLING_FIELD_ID` string
    - `OPTIONS_FILTERS` APICustomFieldOptionsFilter[]
      - `CONTROLLING_VALUE` string
      - `OPTION_IDS` integer[]
  - `JOIN_OBJECT` string

## Other responses

- `401`: Authentication failed.

---

[API](https://skmtc.dev/insightly/apis/insightly-api-v3-1.md) - [All operations](https://skmtc.dev/insightly/apis/insightly-api-v3-1/llms.txt) - [OpenAPI document](https://skmtc.dev/insightly/apis/insightly-api-v3-1/revisions/e7df0c3b65fb?raw)