Skip to main content
GET
/
v1
/
custom-fields
List all custom fields
curl --request GET \
  --url https://api.minimo.it/v1/custom-fields \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "key": "COMPANY_SIZE",
      "display_name": "Company Size",
      "type": "text",
      "category": "Company Info",
      "visibility": true,
      "source": "Manual"
    }
  ]
}
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/v1/custom-fields?groupBy=category' \
  --header 'Authorization: Bearer mn-YOUR_CLIENT_ID-YOUR_API_KEY'
Grouped Response: 
{
  "data": {
    "groups": [
      {
        "category": "Company Info",
        "fields": [
          { "id": 1, "key": "COMPANY_SIZE", "display_name": "Company Size", "type": "text" },
          { "id": 2, "key": "INDUSTRY", "display_name": "Industry", "type": "select" }
        ]
      },
      {
        "category": "uncategorized",
        "fields": [
          { "id": 3, "key": "NOTES", "display_name": "Notes", "type": "text" }
        ]
      }
    ],
    "total": 3
  }
}
Fields without a category are automatically grouped under uncategorized.

​
Field Types

TypeDescription
textFree text input
numberNumeric value
booleanTrue/false
dateDate value
datetimeDate and time
selectSingle selection from options
jsonJSON object

​
Common Errors

ErrorCauseSolution
unauthorizedInvalid API keyCheck Authorization header format
invalid_group_byInvalid groupBy valueUse category or omit the parameter

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
groupBy
enum<string>

Group results by specified field (only 'category' is supported)

Available options:
category

Response

Successful response with custom fields

​
data
object
Example:
{
  "id": 1,
  "key": "COMPANY_SIZE",
  "display_name": "Company Size",
  "type": "text",
  "category": "Company Info",
  "visibility": true,
  "source": "Manual"
}