Modular content fields

If you have Modular Content fields, you can use GraphQL fragments to fetch information about all their embedded blocks.

Suppose a blog_post model has a modular content field called content, which in turn accepts the following block models:

• Block blog_post_text_block: made of a text field (multi-paragraph text);

• Block blog_post_quote_block: made of a quote field (multi-paragraph text) and author field (single-line string);

• Block blog_post_gallery_block: made of a gallery field (image gallery);

This GraphQL query will do the work:

1
query {
2
  allBlogPosts {
3
    title
4
    content {
5
      ... on BlogPostTextBlockRecord {
6
        id
7
        _modelApiKey
8
        text
9
      }
10
      ... on BlogPostQuoteBlockRecord {
11
        id
12
        _modelApiKey
13
        quote
14
        author
15
      }
16
      ... on BlogPostGalleryBlockRecord {
17
        id
18
        _modelApiKey
19
        gallery { url }
20
      }
21
    }
22
  }
23
}

Since all records implement the GraphQL interface RecordInterface, you can dry up the same query like this:

1
query {
2
  allBlogPosts {
3
    title
4
    content {
5
      ... on RecordInterface {
6
        id
7
        _modelApiKey
8
      }
9
      ... on BlogPostTextBlockRecord {
10
        text
11
      }
12
      ... on BlogPostQuoteBlockRecord {
13
        quote
14
        author
15
      }
16
      ... on BlogPostGalleryBlockRecord {
17
        gallery { url }
18
      }
19
    }
20
  }
21
}

The outcome of this query hinges on the type of Modular Content field. If we're dealing with the Multiple Blocks variant, it'll return an array of blocks. However, if we're working with the Single Block variant, it'll simply return one block, or null if it's absent.

Filtering records by contained blocks

If you need to filter records based on the content within their embedded blocks, please refer to the Deep filtering section of this guide, where this scenario is explained in detail.