Content Management API > Model/Block model

List models referencing another model/block

Returns all models that reference the specified item type, either directly through fields or indirectly through nested blocks.

For Block Models (modular_block: true)

Returns all models that can embed the specified block model, including:

Direct embedding via:

rich_text fields (Modular Content) — specified in the rich_text_blocks validator
single_block fields — specified in the single_block_blocks validator
structured_text fields — specified in the structured_text_blocks or structured_text_inline_blocks validators

Indirect embedding:

Models that embed other block models, which themselves contain fields that can embed the target block (recursive traversal through nested block structures)

For Regular Models (modular_block: false)

Returns all models that reference the specified model, including:

Direct references via:

link fields (Single link) — specified in the item_item_type validator
links fields (Multiple links) — specified in the items_item_type validator
structured_text fields — specified in the structured_text_links validator

Indirect references:

Models that embed block models containing fields that reference the target model (traversal through nested block structures to find references within blocks)

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.

item_type string

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

Example:

"name,api_key,collection_appearance,singleton_item"

Returns

Returns an array of resource objects of type item_type.

Examples

1
GET https://site-api.datocms.com/item-types/:model_id_or_api_key/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/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/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": "item_type",
11
      "id": "DxMaW10UQiCmZcuuA-IkkA",
12
      "relationships": {
13
        "singleton_item": {
14
          "data": null
15
        },
16
        "fields": {
17
          "data": [
18
            {
19
              "type": "field",
20
              "id": "Pkg-oztERp6o-Rj76nYKJg"
21
            }
22
          ]
23
        },
24
        "fieldsets": {
25
          "data": [
26
            {
27
              "type": "fieldset",
28
              "id": "93Y1C2sySkG4Eg0atBRIwg"
29
            }
30
          ]
31
        },
32
        "presentation_title_field": {
33
          "data": null
34
        },
35
        "presentation_image_field": {
36
          "data": null
37
        },
38
        "title_field": {
39
          "data": null
40
        },
41
        "image_preview_field": {
42
          "data": null
43
        },
44
        "excerpt_field": {
45
          "data": null
46
        },
47
        "ordering_field": {
48
          "data": null
49
        },
50
        "workflow": {
51
          "data": null
52
        }
53
      },
54
      "attributes": {
55
        "name": "Blog post",
56
        "api_key": "post",
57
        "singleton": false,
58
        "sortable": true,
59
        "modular_block": false,
60
        "tree": false,
61
        "ordering_direction": null,
62
        "ordering_meta": "created_at",
63
        "draft_mode_active": false,
64
        "all_locales_required": false,
65
        "collection_appearance": "compact",
66
        "hint": "Blog posts will be shown in our website under the Blog section",
67
        "inverse_relationships_enabled": false,
68
        "draft_saving_active": false
69
      },
70
      "meta": {
71
        "has_singleton_item": false
72
      }
73
    }
74
  ]
75
}