get
https://api.duodeal.app/api/custom-fields
Retrieves a paginated list of all custom fields defined for the company.
Custom fields allow you to extend entities (deals, customers, products, etc.) with additional data fields.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number for pagination (default: 1) |
limit | integer | No | Number of items per page (default: 50) |
order | string | No | Field to sort by (default: id) |
direction | string | No | Sort direction: asc or desc (default: desc) |
Response Fields
| Field | Type | Description |
|---|---|---|
id | integer | Custom field unique identifier |
name | string | Internal field name (used as key in customFields) |
label | string | Display label shown in the UI |
type | string | Field type (see Field Types below) |
scope | string | Entity this field applies to (see Scopes below) |
required | boolean | Whether the field is mandatory |
formula | string | Formula expression (for Formula type) |
options | object | Options configuration (for Select/MultiSelect) |
weight | integer | Sort order/priority |
size | string | CSS width class (e.g., w-full, w-1/2) |
editable | boolean | Whether the field can be edited by users |
public | boolean | Whether the field is visible publicly |
activate | boolean | Whether the field is active |
enableAi | boolean | Whether AI features are enabled for this field |
hubspotMap | string | HubSpot property mapping |
isMappedToHubspot | boolean | Whether synced with HubSpot |
createdAt | datetime | Creation timestamp |
updatedAt | datetime | Last update timestamp |
Field Types
| Type | Description |
|---|---|
Text | Single-line text input |
MultilineText | Multi-line text area |
RichText | Rich text editor (HTML) |
Number | Numeric input |
Date | Date picker |
datetime | Date and time picker |
Select | Single-choice dropdown |
MultiSelect | Multiple-choice dropdown |
Image | Image upload |
User | User selector |
Formula | Calculated field |
Html | Raw HTML content |
System | System-managed field |
Scopes
| Scope | Description |
|---|---|
deal | Deal/opportunity fields |
customer | Customer/contact fields |
customer-company | Customer company fields |
product | Product catalog fields |
quotation | Quotation fields |
quotation-line | Quotation line item fields |
Filtering
This endpoint supports advanced filtering. See the Filter System Documentation for the complete list of operators and usage examples.
Quick examples:
?filters[scope][eq]=deal
?filters[type][eq]=Select
?filters[required][eq]=true
?filters[activate][eq]=trueResponse
200 OK: Returns paginated list of custom fields401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Successful response
Unauthorized