List all custom fields
curl --request GET \
--url https://api.minimo.it/public/v1/custom-fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.minimo.it/public/v1/custom-fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.minimo.it/public/v1/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.minimo.it/public/v1/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.minimo.it/public/v1/custom-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.minimo.it/public/v1/custom-fields")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.minimo.it/public/v1/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"key": "COMPANY_SIZE",
"displayName": "Company Size",
"type": "text",
"category": "Company Info",
"visibility": true,
"source": "Manual"
}
]
}{
"error": "Missing API client ID or API key"
}Custom Fields
List Custom Fields
Retrieve all custom fields defined for your account
GET
/
public
/
v1
/
custom-fields
List all custom fields
curl --request GET \
--url https://api.minimo.it/public/v1/custom-fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.minimo.it/public/v1/custom-fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.minimo.it/public/v1/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.minimo.it/public/v1/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.minimo.it/public/v1/custom-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.minimo.it/public/v1/custom-fields")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.minimo.it/public/v1/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"key": "COMPANY_SIZE",
"displayName": "Company Size",
"type": "text",
"category": "Company Info",
"visibility": true,
"source": "Manual"
}
]
}{
"error": "Missing API client ID or API key"
}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 thegroupBy=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 |
Related Endpoints
- Create Custom Field: Create a new custom field
- Create or Update Contact: Create and update contacts with custom field values
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Group results by specified field (only 'category' is supported)
Available options:
category Response
Successful response with custom fields
- object[]
- object
Show child attributes
Show child attributes
Example:
{
"id": 1,
"key": "COMPANY_SIZE",
"displayName": "Company Size",
"type": "text",
"category": "Company Info",
"visibility": true,
"source": "Manual"
}