Custom Field Definitions
List custom field definitions
Returns custom field definitions for the account. Without project_id, only account-wide definitions are returned; pass project_id to also include definitions scoped to that project.
GET
/
custom_field_definitions
List custom field definitions
curl --request GET \
--url https://app.gomangrove.com/api/v1/custom_field_definitions \
--header 'Authorization: <api-key>'import requests
url = "https://app.gomangrove.com/api/v1/custom_field_definitions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.gomangrove.com/api/v1/custom_field_definitions', 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://app.gomangrove.com/api/v1/custom_field_definitions",
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: <api-key>"
],
]);
$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://app.gomangrove.com/api/v1/custom_field_definitions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.gomangrove.com/api/v1/custom_field_definitions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/custom_field_definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 42,
"friendly_id": "cfd_abc123def456",
"key": "serial",
"label": "Serial Number",
"object_type": "asset",
"value_type": "string",
"enumeration_options": null,
"order": 1,
"is_required": false,
"project_id": null,
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z"
}
],
"info": {
"items": 1,
"page_size": 20,
"total_items": 1,
"current_page": 1,
"next_page": null,
"previous_page": null,
"total_pages": 1,
"sort": [],
"filter": []
}
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Unknown object_type. Valid values: project, asset"
}
]
}Authorizations
Query Parameters
Filter by the record type the definitions apply to
Available options:
project, asset Project friendly ID (e.g., prj_abc123). Widens the result to include that project's scoped definitions.
Previous
Retrieve a custom field definitionReturns a specific custom field definition by friendly ID.
Next
⌘I
List custom field definitions
curl --request GET \
--url https://app.gomangrove.com/api/v1/custom_field_definitions \
--header 'Authorization: <api-key>'import requests
url = "https://app.gomangrove.com/api/v1/custom_field_definitions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.gomangrove.com/api/v1/custom_field_definitions', 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://app.gomangrove.com/api/v1/custom_field_definitions",
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: <api-key>"
],
]);
$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://app.gomangrove.com/api/v1/custom_field_definitions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.gomangrove.com/api/v1/custom_field_definitions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/custom_field_definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 42,
"friendly_id": "cfd_abc123def456",
"key": "serial",
"label": "Serial Number",
"object_type": "asset",
"value_type": "string",
"enumeration_options": null,
"order": 1,
"is_required": false,
"project_id": null,
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z"
}
],
"info": {
"items": 1,
"page_size": 20,
"total_items": 1,
"current_page": 1,
"next_page": null,
"previous_page": null,
"total_pages": 1,
"sort": [],
"filter": []
}
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Unknown object_type. Valid values: project, asset"
}
]
}