Show examples in:
Javascript HTTP
Endpoint info
Available examples
Content Management API > Field

List related fields

Warning: Experimental API

Please note that this API method is marked as unstable and should be avoided in production environments. Changes may occur at any time without warning, potentially impacting your scripts. We recommend contacting our Support Team to explore alternative approaches that are safer and more reliable!

Returns all the model fields, plus all the fields of the blocks its fields reference

Returns

Returns an array of resource objects of type field.

Examples

GET https://site-api.datocms.com/item-types/:model_id_or_api_key/fields/related HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Terminal window
curl -g 'https://site-api.datocms.com/item-types/:model_id_or_api_key/fields/related' \
\
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3"
await fetch(
"https://site-api.datocms.com/item-types/:model_id_or_api_key/fields/related",
{
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
},
},
);
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": [
{
"type": "field",
"id": "Pkg-oztERp6o-Rj76nYKJg",
"attributes": {
"label": "Title",
"field_type": "string",
"api_key": "title",
"localized": true,
"validators": {
"required": {}
},
"position": 1,
"hint": "This field will be used as post title",
"default_value": {
"en": "A default value",
"it": "Un valore di default"
},
"appearance": {
"editor": "single_line",
"parameters": {
"heading": false
},
"addons": [
{
"id": "1234",
"field_extension": "lorem_ipsum",
"parameters": {}
}
]
},
"deep_filtering_enabled": true
},
"relationships": {
"item_type": {
"data": {
"type": "item_type",
"id": "DxMaW10UQiCmZcuuA-IkkA"
}
},
"fieldset": {
"data": null
}
}
}
]
}