Use the groupBy=category query parameter to get custom fields organized by category for easier management.
Use Cases
- Display field options: Show available custom fields in your application UI
- Integration mapping: Map external CRM fields to Minimo custom fields
- Data validation: Check which fields exist before creating contacts
Group by Category
Get custom fields organized by category by adding the groupBy=category query parameter:
curl --request GET \
--url 'https://api.minimo.it/public/v1/custom-fields?groupBy=category' \
--header 'Authorization: Bearer mn-YOUR_CLIENT_ID-YOUR_API_KEY'
{
"data": {
"groups": [
{
"category": "Company Info",
"fields": [
{ "id": 1, "key": "COMPANY_SIZE", "displayName": "Company Size", "type": "text" },
{ "id": 2, "key": "INDUSTRY", "displayName": "Industry", "type": "select" }
]
},
{
"category": "uncategorized",
"fields": [
{ "id": 3, "key": "NOTES", "displayName": "Notes", "type": "text" }
]
}
],
"total": 3
}
}
Fields without a category are automatically grouped under uncategorized.
Field Types
| Type | Description |
|---|
text | Free text input |
number | Numeric value |
boolean | True/false |
date | Date value |
datetime | Date and time |
select | Single selection from options |
json | JSON object |
Common Errors
| Error | Cause | Solution |
|---|
unauthorized | Invalid API key | Check Authorization header format |
invalid_group_by | Invalid groupBy value | Use category or omit the parameter |
