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.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.
Base URL
Authentication
Every request must include a bearer token in theAuthorization header and the API version in the Version header.
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: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 — create and manage custom object schemas that host custom fields
- Associations API overview — link records across object types
- OAuth 2.0 overview — obtain and refresh access tokens