# Get Custom Fields

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-fields
- **Summary:** Get Custom Fields

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-fields#__docusaurus_skipToContent_fallback)

Version: v3

Get Custom Fields
=================

GET 

https://services.leadconnectorhq.com/locations/:locationId/customFields

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

Get Custom Fields

### Requirements

#### Scope(s)

`locations/customFields.readonly`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-fields#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

### Path Parameters

**locationId** stringrequired

Location Id

**Example:** `ve9EPM428h8vShlRW1KT`

### Query Parameters

**model** string

**Possible values:** \[`contact`, `opportunity`, `all`\]

Model of the custom field you want to retrieve

**Example:** `opportunity`

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-fields#responses "Direct link to Responses")

*   200
*   400
*   401
*   422

Successful response

*   application/json

*   Schema
*   Example (auto)

**Schema**

**customFields** object\[\]

*   Array \[\
    \
\
**id**string\
\
**Example:** `3sv6UEo51C9Bmpo1cKTq`\
\
**name**string\
\
**Example:** `pincode`\
\
**fieldKey**string\
\
**Example:** `contact.pincode`\
\
**placeholder**string\
\
**Example:** `Pin code`\
\
**dataType**string\
\
**Example:** `TEXT`\
\
**position**number\
\
**Example:** `0`\
\
**picklistOptions**string\[\]\
\
**Example:** `["first option"]`\
\
**picklistImageOptions**string\[\]\
\
**Example:** `[]`\
\
**isAllowedCustomOption**boolean\
\
**Example:** `false`\
\
**isMultiFileAllowed**boolean\
\
**Example:** `true`\
\
**maxFileLimit**number\
\
**Example:** `4`\
\
**locationId**string\
\
**Example:** `3sv6UEo51C9Bmpo1cKTq`\
\
**model**string\
\
Model of the custom field\
\
**Possible values:** \[`contact`, `opportunity`\]\
\
**Example:** `opportunity`\
\
*   \]
    

    {  "customFields": [    {      "id": "3sv6UEo51C9Bmpo1cKTq",      "name": "pincode",      "fieldKey": "contact.pincode",      "placeholder": "Pin code",      "dataType": "TEXT",      "position": 0,      "picklistOptions": [        "first option"      ],      "picklistImageOptions": [],      "isAllowedCustomOption": false,      "isMultiFileAllowed": true,      "maxFileLimit": 4,      "locationId": "3sv6UEo51C9Bmpo1cKTq",      "model": "opportunity"    }  ]}
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/locations/sub-account-formerly-location-api#authentication)
**type:** http**scopes:** `locations/customFields.readonly`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L 'https://services.leadconnectorhq.com/locations/ve9EPM428h8vShlRW1KT/customFields?model=opportunity' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

Version — headerrequired\---v3

Show optional parameters

model — query\---contactopportunityall

Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!