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
.png?fit=max&auto=format&n=EQK5eX9kTD8NzWwA&q=85&s=878008bf159fcc4964d0c0d508b6e400)