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)

Returns

Returns an array of resource objects of type item_type

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const modelIdOrApiKey = "blog_post";
7

8
  const itemTypes = await client.itemTypes.referencing(modelIdOrApiKey);
9

10
  for (const itemType of itemTypes) {
11
    // Check the 'Returned output' tab for the result ☝️
12
    console.log(itemType);
13
  }
14
}
15

16
run();

1
{
2
  id: "DxMaW10UQiCmZcuuA-IkkA",
3
  name: "Blog post",
4
  api_key: "post",
5
  singleton: false,
6
  sortable: true,
7
  modular_block: false,
8
  tree: false,
9
  ordering_direction: null,
10
  ordering_meta: "created_at",
11
  draft_mode_active: false,
12
  all_locales_required: false,
13
  collection_appearance: "compact",
14
  hint: "Blog posts will be shown in our website under the Blog section",
15
  inverse_relationships_enabled: false,
16
  draft_saving_active: false,
17
  meta: { has_singleton_item: false },
18
  singleton_item: null,
19
  fields: [{ type: "field", id: "Pkg-oztERp6o-Rj76nYKJg" }],
20
  fieldsets: [{ type: "fieldset", id: "93Y1C2sySkG4Eg0atBRIwg" }],
21
  presentation_title_field: null,
22
  presentation_image_field: null,
23
  title_field: null,
24
  image_preview_field: null,
25
  excerpt_field: null,
26
  ordering_field: null,
27
  workflow: null,
28
}