Delivery GraphQL API reference

query GetArticles {
  article_All(limit: 1000) {
    items {
      title
    }
  }
}

query GetArticlesWithRelatedArticles {
  article_All(limit: 100) {
    items {
      title
      relatedArticles(limit: 20) {
        items {
          _system_ {
            name
          }
        }
      }
    }
  }
}

# Total query depth = 5
query GetImagesInArticle {
  article_All {     # level 0
    items {         # level 1
      bodyCopy {    # level 2
        assets {    # level 3
          items {   # level 4
            url     # level 5
          }
        }
      }
    }
  }
}

# Total query depth = 4
query GetPostsAndArticles {
  # Depth is 2 levels
  article_All { # level 0
    items {     # level 1
      title     # level 2
      url       # level 2
    }
  }
  # Depth is 2 levels
  post_All {  # level 0
    items {   # level 1
      title   # level 2
      url     # level 2
    }
  }
}

query GetArticleByCodename {
  article(codename: "my_article") {
    title
    slug
  }
}

query GetArticleById {
  article(id: "c706af79-2a4f-41e4-9bec-8c8383e00944") {
    title
    slug
  }
}

query GetArticles {
  article_All {
    items {
      title
      slug
    }
  }
}

query GetOrderedItems {
  # Get articles ordered by their title from Z to A
  article_All(order: {title: desc}) {
    items {
      title
    }
  }
  # Blog posts ordered by codename from A to Z
  post_All(order: {_system_: {codename: asc}}) {
    items {
      title
    }
  }
}

query GetSpanishArticles {
  # Requests articles in Spanish
  article_All(languageFilter: {languageCodename: "es-ES"}) {
    items {
      _system_ {
        language {
          _system_ {
            codename
          }
        }
      }
      title
      slug
    }
  }
}

query GetNonArchivedArticles {
  article_All(where: {_system_: {workflowStep: {notEq: "archived"}}}) {
    items {
      title
    }
  }
}

query GetArticlesByComplexCondition {
  article_All(where: {AND: [
    {OR: [
      {title: {eq: "On Roasts"}},
      {title: {eq: "Donate with us"}},
    ]},
    {summary: {isEmpty: false}}
  ]}) {
    items {
      title
    }
  }
}

# Paginating articles
query GetPaginatedArticles {
  article_All(limit: 10, offset: 10) {
    items {
      title
    }
    offset      # Returns the specified offset
    limit       # Returns the specified limit
    totalCount  # Returns the total number of content items that match the query
  }
}

# Paginating linked content in rich text
query GetPaginatedLinkedItems {
  article_All {
    items {
      bodyCopy {
        html
        linkedItems(offset: 10, limit: 10) {
          items {
            _system_ {
              codename
            }
          }
          offset      # Returns the specified offset
          limit       # Returns the specified limit
          totalCount  # Returns the total number of content items that match the query
        }
      }
    }
  }
}

type Article implements _Item {
  ...
  teaserImage(          # Asset element
    offset: Int!
    limit: Int!
    totalCount: Int!
  ): _AssetCollection!
  relatedArticles(      # Linked items element
    offset: Int!
    limit: Int!
    totalCount: Int!
  ): _ItemCollection!
  personas(             # Taxonomy element
    offset: Int!
    limit: Int!
    totalCount: Int!
  ): _TaxonomyTermCollection!
}

query HowToQueryCollectionFields {
  article_All {
    items {
      teaserImage {
        items {
          name
        }
        totalCount # Returns the total number of assets inserted in the asset element
      }
      personas {
        items {
          _system_ {
            codename
          }
        }
        totalCount # Returns the total number of selected taxonomy terms
      }
      relatedArticles {
        items {
          ... on Article {
            title
          }
        }
        totalCount # Returns the total number of items linked in the element
      }
    }
    totalCount # Returns the total number of articles matching the query
  }
}

type Article implements _Item {
  _system_: _Sys!                         # The content item's metadata.
  title: String!                          # Text element
  teaserImage(                            # Asset element
    offset: Int = 0
    limit: Int = 10
  ): _AssetCollection!
  postDate_with_timezone: _DateAndTime    # Date & time element
  bodyCopy: _RichText!                    # Rich text element
  relatedArticles(                        # Linked items element
    offset: Int = 0
    limit: Int = 10
  ): _ItemCollection!
  personas(                               # Taxonomy element
    offset: Int = 0
    limit: Int = 10
  ): _TaxonomyTermCollection!
  urlPattern: String!                     # URL slug element
}

type _Sys {
  name: String!     # The content item's display name.
  codename: String! # The content item's codename.
  language: _Language!  # Metadata of the content item's language.
  type: _ContentType!   # Metadata of the content item's content type.
  lastModified: DateTime! # ISO-8601 formatted date and time of the last change to user-content of the content item. The value is not affected when moving content items through workflow steps.
  collection: _Collection!      # Metadata of the content item's collection.
  workflow: _Workflow!  # Metadata of the content item's current workflow.
  workflowStep: _WorkflowStep!  # Metadata of the content item's current workflow step.
  id: Guid! # The content item's internal ID.
}

type _Collection {
  _system_: _CollectionSys! # The collection's predefined system fields.
}

type _CollectionSys {
  codename: String! # The collection's codename.
}

type _ContentType {
  _system_: _ContentTypeSys! # The content type's predefined system fields.
}

type _ContentTypeSys {
  name: String!     # The content type's display name.
  codename: String! # The content type's codename.
}

type _Language {
  _system_: _LanguageSys! # The language's predefined system fields.
}

type _LanguageSys {
  name: String!     # The language's display name.
  codename: String! # The language's codename.
}

type _Workflow {
  _system_: _WorkflowSys! # The workflow's predefined system fields.
}

type _WorkflowSys {
  codename: String! # The workflow's codename.
}

type _WorkflowStep {
  _system_: _WorkflowStepSys! # The workflow step's predefined system fields.
}

type _WorkflowStepSys {
  codename: String! # The workflow step's codename.
}

type _Asset implements _AssetInterface {
  renditions: _AssetRenditionCollection # List of renditions available for this asset.
  url: String!  # The asset's absolute URL.
  name: String  # The asset's display name.
  description: String   # The asset's alt text description for a specific language.
  type: String  # The file's MIME type.
  size: Int     # The file's size in bytes.
  width: Int    # The image's width in pixels.
  height: Int   # The image's height in pixels.
}

type _AssetRenditionCollection {
  offset: Int!
  limit: Int!
  totalCount: Int!
  items: [_Rendition!]! # Individual asset rendition objects.
}

type _Rendition {
  preset: String!         # The image preset's codename.
  preset_id: String!      # The image preset's ID.
  rendition_id: String!  # The rendition's ID.
  query: String!          # Parameters set for the image rendition. Need to be concatenated with the original asset's URL to customize the image.
  width: Int!              # The rendition's width.
  height: Int!           # The rendition's height.
}

type _RichTextAsset implements _AssetInterface {
  imageId: String!  # Identifier of the asset as used in the rich text element.
  url: String!      # The asset's absolute URL.
  name: String      # The asset's display name.
  description: String   # The asset's alt text description for a specific language.
  type: String      # The file's MIME type.
  size: Int         # The file's size in bytes.
  width: Int        # The image's width in pixels.
  height: Int       # The image's height in pixels.
}

type Metadata {
  metaTitle: String!
  metaDescription: String!
}

type Article implements _Item {
  _system_: _Sys! # The content item's predefined system fields.
  ...
  _metadata: Metadata! # The Metadata type with subfields for each element in the snippet
}

type _CustomElement {
  value: String # The custom element's value as a string.
}

type _DateAndTime {
  value: DateTime # The element's datetime output.
  display_timezone: String # The element's display timezone.
}

type Article implements _Item {
  _system_: _Sys! # The content item's predefined system fields.
  ...
  relatedContent: _ItemCollection! # Linked items element without content type limitation
}

type Article implements _Item {
  _system_: _Sys! # The content item's predefined system fields.
  ...
  relatedArticle: Article # Linked items element limited to a single Article content type
  relatedArticles: Article_RelatedArticles_Collection! # Linked items element limited Article content types
}

type Article_RelatedArticles_Collection {
  offset: Int!
  limit: Int!
  items: [Article!]!
}

type _MultipleChoiceOptionCollection {
  offset: Int!
  limit: Int!
  items: [_MultipleChoiceOption!]! # Specifies the selected multiple choice options.
}

type _MultipleChoiceOption {
  _system_: _MultipleChoiceOptionSys! # The multiple choice option's predefined system fields.
}

type _MultipleChoiceOptionSys {
  name: String!     # The multiple choice option's display name.
  codename: String! # The multiple choice option's codename.
}

type Article implements _Item {
  _system_: _Sys!   # The content item's predefined system fields.
  ...
  bodyCopy: _RichText! # Rich text element without type limitations
}

type _RichText {
  html: String! # The rich text's HTML output. Contains references to assets, links to content items, linked content, and components.
  itemHyperlinks: _ItemCollection!  # Contains the content items referenced in hyperlinks.
  assets: _RichTextAssetCollection! # Contains the assets inserted into the rich text.
  linkedItems: _ItemCollection!     # Contains the content items inserted into the rich text.
  components: _ItemCollection!      # Contains the components inserted into the rich text.
}

type Article implements _Item {
  _system_: _Sys!   # The content item's predefined system fields.
  ...
  bodyCopy: Article_BodyCopy! # Rich text element with custom type limitations
}

type Article_BodyCopy {
  html: String!
  itemHyperlinks: _ItemCollection!
  assets: _RichTextAssetCollection!
  components: Article_BodyCopy_Components_Collection!
  linkedItems: Article_BodyCopy_LinkedItems_Collection!
}

type Article_BodyCopy_Components_Collection {
  offset: Int!
  limit: Int!
  items: [Tweet!]!
}

type Article_BodyCopy_LinkedItems_Collection {
  offset: Int!
  limit: Int!
  items: [Tweet!]!
}

type _TaxonomyTermCollection {
  offset: Int!
  limit: Int!
  items: [_TaxonomyTerm!]! # Specifies the selected taxonomy terms.
}

type _TaxonomyTerm {
  _system_: _TaxonomyTermSys! # The taxonomy term's predefined system fields.
}

type _TaxonomyTermSys {
  name: String!     # The taxonomy term's display name.
  codename: String! # The taxonomy term's codename.
}