> ## Documentation Index
> Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Fields Overview

> Create and manage custom field schemas for contacts, companies, and custom objects in the HoopAI Platform REST API.

The Custom Fields V2 API lets you define and manage custom field schemas attached to standard objects — such as companies — and custom objects within your HoopAI Platform account. You can create fields of many data types (text, numeric, date, file upload, selection options, and more), organize them into folders, and retrieve or delete them programmatically.

## Base URL

```
https://services.leadconnectorhq.com
```

## Authentication

Every request must include a bearer token in the `Authorization` header and the API version in the `Version` header.

```http theme={null}
Authorization: Bearer <access_token>
Version: 2021-07-28
```

Use an access token generated for a **Account** user type, or a Private Integration Token scoped to the account.

## OAuth scopes

| Scope                             | Access                                               |
| --------------------------------- | ---------------------------------------------------- |
| `locations/customFields.readonly` | Read custom fields and folders                       |
| `locations/customFields.write`    | Create, update, and delete custom fields and folders |

## Quick start

Retrieve all custom fields for a custom object:

```bash theme={null}
curl -X GET "https://services.leadconnectorhq.com/custom-fields/object-key/custom_objects.pet?locationId=ve9EPM428h8vShlRW1KT" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"
```

## Endpoints

| Method   | Path                                    | Description                     |
| -------- | --------------------------------------- | ------------------------------- |
| `POST`   | `/custom-fields/`                       | Create Custom Field             |
| `GET`    | `/custom-fields/{id}`                   | Get Custom Field / Folder By Id |
| `PUT`    | `/custom-fields/{id}`                   | Update Custom Field By Id       |
| `DELETE` | `/custom-fields/{id}`                   | Delete Custom Field By Id       |
| `GET`    | `/custom-fields/object-key/{objectKey}` | Get Custom Fields By Object Key |
| `POST`   | `/custom-fields/folder`                 | Create Custom Field Folder      |
| `PUT`    | `/custom-fields/folder/{id}`            | Update Custom Field Folder Name |
| `DELETE` | `/custom-fields/folder/{id}`            | Delete Custom Field Folder      |

## Related

* [Objects API overview](/api-reference/objects/overview) — create and manage custom object schemas that host custom fields
* [Associations API overview](/api-reference/associations/overview) — link records across object types
* [OAuth 2.0 overview](/api-reference/oauth/overview) — obtain and refresh access tokens