# Get Custom Field / Folder By Id

GET https://services.leadconnectorhq.com/custom-fields/{id}

Get Custom Field / Folder By Id.

:::info
Supports Custom Objects, Company (Business), and Project Management tasks (objectKey: "task", optional scopes). Contact and Opportunity fields continue to use the Locations custom-fields endpoints.
:::

## Authentication

Send `Authorization: Bearer <token>` using:

- **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `locations/customFields.readonly`

## Parameters

### Header Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `Version` | string | Yes | API Version |

### Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the custom field or folder |

## OpenAPI Specification

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "HighLevel API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://services.leadconnectorhq.com"
    }
  ],
  "paths": {
    "/custom-fields/{id}": {
      "get": {
        "summary": "Get Custom Field / Folder By Id",
        "operationId": "getCustomFieldFolderById",
        "description": "Get Custom Field / Folder By Id.\n\n:::info\nSupports Custom Objects, Company (Business), and Project Management tasks (objectKey: \"task\", optional scopes). Contact and Opportunity fields continue to use the Locations custom-fields endpoints.\n:::",
        "parameters": [
          {
            "name": "Version",
            "in": "header",
            "description": "API Version",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "v3"
              ]
            }
          },
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "Unique identifier of the custom field or folder",
            "schema": {
              "example": "661c06b4ffde146bdb469442",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomFieldSuccessfulResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestDTO"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": [
              "locations/customFields.readonly"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
        "type": "http"
      },
      "Location-Access": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
        "type": "http"
      },
      "Location-Access-Only": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account.",
        "type": "http"
      },
      "Agency-Access": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.",
        "type": "http"
      },
      "Agency-Access-Only": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Agency.",
        "type": "http"
      }
    },
    "schemas": {
      "CustomFieldSuccessfulResponseDto": {
        "type": "object",
        "properties": {
          "field": {
            "description": "The custom field or folder matching the requested id",
            "example": {
              "id": "661c06b4ffde146bdb469442",
              "locationId": "ve9EPM428h8vShlRW1KT",
              "name": "Pet Name",
              "fieldKey": "custom_object.pet.name",
              "objectKey": "custom_object.pet",
              "dataType": "TEXT",
              "parentId": "3v34PM428h8vShlRW1KT",
              "showInForms": true,
              "dateAdded": "2025-01-02T09:35:39.032Z",
              "dateUpdated": "2025-01-02T09:35:39.032Z"
            },
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "locationId": {
                    "type": "string",
                    "description": "Location Id",
                    "example": "ve9EPM428h8vShlRW1KT"
                  },
                  "name": {
                    "type": "string",
                    "description": "Field name",
                    "example": "Name"
                  },
                  "description": {
                    "type": "string",
                    "description": "Description of the field",
                    "example": "Pet name field"
                  },
                  "placeholder": {
                    "type": "string",
                    "description": "Placeholder text for the field",
                    "example": "Enter pet name"
                  },
                  "showInForms": {
                    "type": "boolean",
                    "description": "Whether the field should be shown in forms",
                    "example": true
                  },
                  "options": {
                    "description": "Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)",
                    "example": [
                      {
                        "key": "option_a",
                        "label": "Option A"
                      }
                    ],
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "key": {
                          "type": "string",
                          "description": "Key of the option (Included in Create and Response, excluded in Update)",
                          "example": "option_a"
                        },
                        "label": {
                          "type": "string",
                          "description": "Value of the option",
                          "example": "Option A"
                        },
                        "url": {
                          "type": "string",
                          "description": "URL associated with the option (Optional, valid only for RADIO type)",
                          "example": "https://example.com"
                        }
                      },
                      "required": [
                        "key",
                        "label"
                      ],
                      "title": "OptionDTO"
                    }
                  },
                  "acceptedFormats": {
                    "type": "string",
                    "enum": [
                      ".pdf",
                      ".docx",
                      ".doc",
                      ".jpg",
                      ".jpeg",
                      ".png",
                      ".gif",
                      ".csv",
                      ".xlsx",
                      ".xls",
                      "all"
                    ],
                    "description": "Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all",
                    "example": [
                      ".pdf",
                      ".jpg"
                    ]
                  },
                  "id": {
                    "type": "string",
                    "description": "Unique identifier of the object",
                    "example": "661c06b4ffde146bdb469442"
                  },
                  "objectKey": {
                    "type": "string",
                    "description": "The key for your custom / standard object. Use `task` for Project Management tasks, or e.g. `custom_object.pet` for custom objects.",
                    "example": "task"
                  },
                  "originId": {
                    "type": "string",
                    "description": "Origin ID of the object",
                    "example": "661c06b4ffde146bdb469442"
                  },
                  "dataType": {
                    "type": "string",
                    "enum": [
                      "TEXT",
                      "LARGE_TEXT",
                      "NUMERICAL",
                      "PHONE",
                      "MONETORY",
                      "CHECKBOX",
                      "SINGLE_OPTIONS",
                      "MULTIPLE_OPTIONS",
                      "DATE",
                      "TEXTBOX_LIST",
                      "FILE_UPLOAD",
                      "RADIO",
                      "EMAIL"
                    ],
                    "description": "Type of field that you are trying to create",
                    "example": "TEXT"
                  },
                  "parentId": {
                    "type": "string",
                    "description": "ID of the parent folder",
                    "example": "3v34PM428h8vShlRW1KT"
                  },
                  "fieldKey": {
                    "type": "string",
                    "description": "Field key. For Custom Objects: `custom_object.{objectKey}.{fieldKey}`. For standard objects such as tasks: `task.{fieldKey}` (e.g. `task.priority_n`). When setting values via the Projects Tasks API, omit the `task.` prefix in `customFields`.",
                    "example": "task.my_field"
                  },
                  "allowCustomOption": {
                    "type": "boolean",
                    "description": "Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.",
                    "example": true
                  },
                  "maxFileLimit": {
                    "type": "number",
                    "description": "Maximum file limit for uploads",
                    "example": 2
                  },
                  "dateAdded": {
                    "type": "string",
                    "description": "Date and time when the object was added",
                    "format": "date-time",
                    "example": "2025-01-02T09:35:39.032Z"
                  },
                  "dateUpdated": {
                    "type": "string",
                    "description": "Date and time when the object was last updated",
                    "format": "date-time",
                    "example": "2025-01-02T09:35:39.032Z"
                  },
                  "scopes": {
                    "description": "Visibility scopes for this field. Empty array means location-wide. For Projects tasks, entries use scopeType `space` | `folder` | `list` | `workspace` with the wrapper id as scopeId.",
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "scopeType": {
                          "type": "string",
                          "enum": [
                            "workspace",
                            "space",
                            "folder",
                            "list"
                          ]
                        },
                        "scopeId": {
                          "type": "string"
                        }
                      }
                    },
                    "example": [
                      {
                        "scopeType": "list",
                        "scopeId": "6a102435124ecfb348bd5507"
                      }
                    ]
                  }
                },
                "required": [
                  "locationId",
                  "id",
                  "objectKey",
                  "originId",
                  "dataType",
                  "parentId",
                  "fieldKey",
                  "dateAdded",
                  "dateUpdated"
                ],
                "title": "ICustomField"
              }
            ]
          }
        },
        "title": "CustomFieldSuccessfulResponseDto"
      },
      "BadRequestDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 400
          },
          "message": {
            "type": "string",
            "example": "Bad Request"
          }
        },
        "title": "BadRequestDTO"
      },
      "UnauthorizedDTO": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 401
          },
          "message": {
            "type": "string",
            "example": "Invalid token: access token is invalid"
          },
          "error": {
            "type": "string",
            "example": "Unauthorized"
          }
        },
        "title": "UnauthorizedDTO"
      }
    }
  }
}
```

## HighLevel SDK Examples

**Node.js** (`@gohighlevel/api-client`)

```javascript
import HighLevel from '@gohighlevel/api-client';

const ghl = new HighLevel({
  privateIntegrationToken: '<PRIVATE_INTEGRATION_TOKEN>'
});

const response = await ghl.customFields.getCustomFieldFolderById('<ID>');
console.log(response);
```

**Python** (`gohighlevel-api-client`)

```python
from highlevel import HighLevel

client = HighLevel(
    private_integration_token='<PRIVATE_INTEGRATION_TOKEN>'
)

response = await client.customFields.get_custom_field_folder_by_id('<ID>')
print(response)
```

**PHP** (`gohighlevel/api-client`)

```php
<?php
require_once 'vendor/autoload.php';

use HighLevel\HighLevel;
use HighLevel\HighLevelConfig;

$config = new HighLevelConfig([
    'privateIntegrationToken' => '<PRIVATE_INTEGRATION_TOKEN>'
]);
$ghl = new HighLevel($config);

$response = $ghl->customFields->getCustomFieldFolderById('<ID>');
echo json_encode($response, JSON_PRETTY_PRINT);
```

## Code Examples

**cURL**

```bash
curl -L -X GET 'https://services.leadconnectorhq.com/custom-fields/<id>' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Version: v3'
```

**Node.js**

```javascript
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <TOKEN>',
    Version: 'v3'
  }
};

try {
  const response = await fetch('https://services.leadconnectorhq.com/custom-fields/<id>', options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

**Python**

```python
import requests

url = "https://services.leadconnectorhq.com/custom-fields/{id}"

headers = {
    "Authorization": "Bearer <TOKEN>",
    "Version": "v3"
}

response = requests.get(url, headers=headers)
print(response.json())
```

**PHP**

```php
<?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://services.leadconnectorhq.com/custom-fields/<id>',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Version: v3',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

**Java**

```java
HttpResponse<String> response = Unirest
  .get("https://services.leadconnectorhq.com/custom-fields/<id>")
  .header("Authorization", "Bearer <TOKEN>")
  .header("Version", "v3")
  .asString();
```

**Go**

```go
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {
  url := "https://services.leadconnectorhq.com/custom-fields/<id>"
  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "Bearer <TOKEN>")
  req.Header.Add("Version", "v3")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}
```

**Ruby**

```ruby
require 'uri'
require 'net/http'

url = URI("https://services.leadconnectorhq.com/custom-fields/<id>")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer <TOKEN>"
request["Version"] = "v3"

response = http.request(request)
puts response.read_body
```

**PowerShell**

```powershell
$headers = @{
  "Authorization" = "Bearer <TOKEN>"
  "Version" = "v3"
}

$response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/custom-fields/<id>' -Method 'GET' -Headers $headers
$response | ConvertTo-Json
```