---
title: "Gets a list of Custom Fields"
method: GET
path: "/CustomFields/{objectName}"
tags: ["CustomFields"]
---

# Gets a list of Custom Fields

`GET /CustomFields/{objectName}`

## Request

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

Use this API call to get a list of custom fields metadata. The properties FIELD_NAME and FIELD_ORDER can be used to determine which fields belong to a particular object. A common problem API users have is to reference an invalid FIELD_NAME when referencing custom fields in a newly created or updated object.            If you plan to use custom fields in your API based application, be sure you are working with valid custom field names. To add or update custom fields for your Insightly instance, you'll need to go to the web app to do so.

## Path parameters

- `objectName` string, required

## Response `200`

Request succeeded.

- APICustomFieldMetadata[]
  - `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

- `400`: Often missing or invalid parameter.
- `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)