Query by Type

Here we discuss how to query all the documents of a certain custom type from your content repository.

By One Type

Example 1

This first example shows how to query all of the documents of the custom type "blog-post". The option included in this query will sort the results by their "date" field (from most recent to the oldest).

Copy
response = api.query(
    Prismic::Predicates.at("document.type", "blog-post"),
    { "orderings" => "[my.blog-post.date desc]" }
)
# response is the response object, response.results holds the documents

Example 2

The following example shows how to query all of the documents of the custom type "video-game". The options will make it so that the results are sorted alphabetically, limited to 10 games per page, and showing the second page of results.

Copy
response = api.query(
    Prismic::Predicates.at("document.type", "video-game"),
    { "pageSize" => 10, "page" => 2, "orderings" => "[my.video-game.title]" }
)
# response is the response object, response.results holds the documents

By Multiple Types

This example shows how to query all of the documents of two different custom types: "article" and "blog_post".

Copy
response = api.query(
  Prismic::Predicates.any("document.type", ["article", "blog_post"])
)
# response is the response object, response.results holds the documents

Was this article helpful?
Not really
Yes, Thanks

Can't find what you're looking for? Get in touch with us on our Community Forum.