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

List all fields of a model/block

Query parameters

fieldsobject

Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.

fieldstring

Attributes and relationships to return for each field that this endpoint returns.

Example:"label,field_type,localized,item_type"

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 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' \
\
-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",
{
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,
"content_link_enabled": true
},
"relationships": {
"item_type": {
"data": {
"type": "item_type",
"id": "DxMaW10UQiCmZcuuA-IkkA"
}
},
"fieldset": {
"data": null
}
}
}
]
}