Content Management API > Field

List fields referencing a model/block

Returns all fields in the project that reference a specific model (works both for Models and Block Models)

Query parameters

fields object

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.

field string

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

1
GET https://site-api.datocms.com/item-types/:model_id_or_api_key/fields/referencing HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3

1
curl -g 'https://site-api.datocms.com/item-types/:model_id_or_api_key/fields/referencing' \
2
   \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3"

1
await fetch(
2
  "https://site-api.datocms.com/item-types/:model_id_or_api_key/fields/referencing",
3
  {
4
    headers: {
5
      Authorization: "Bearer YOUR-API-TOKEN",
6
      Accept: "application/json",
7
      "X-Api-Version": "3",
8
    },
9
  },
10
);

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": [
9
    {
10
      "type": "field",
11
      "id": "Pkg-oztERp6o-Rj76nYKJg",
12
      "attributes": {
13
        "label": "Title",
14
        "field_type": "string",
15
        "api_key": "title",
16
        "localized": true,
17
        "validators": {
18
          "required": {}
19
        },
20
        "position": 1,
21
        "hint": "This field will be used as post title",
22
        "default_value": {
23
          "en": "A default value",
24
          "it": "Un valore di default"
25
        },
26
        "appearance": {
27
          "editor": "single_line",
28
          "parameters": {
29
            "heading": false
30
          },
31
          "addons": [
32
            {
33
              "id": "1234",
34
              "field_extension": "lorem_ipsum",
35
              "parameters": {}
36
            }
37
          ]
38
        },
39
        "deep_filtering_enabled": true,
40
        "content_link_enabled": true
41
      },
42
      "relationships": {
43
        "item_type": {
44
          "data": {
45
            "type": "item_type",
46
            "id": "DxMaW10UQiCmZcuuA-IkkA"
47
          }
48
        },
49
        "fieldset": {
50
          "data": null
51
        }
52
      }
53
    }
54
  ]
55
}