Fetch Data

Make queries to the Prismic API to get content into your Next.js application.

In this article, you’ll learn how to perform queries to the Prismic API to retrieve content in your Next.js application.

Recommended data fetching method

Next.js has many different ways to fetch data. Prismic works with all data-fetching methods, but Next.js recommends static rendering for the best website performance.

How to fetch data when statically rendering depends on whether or not you are using the App Router or the Pages Router. Next.js introduced the App Router in version 13. In doing so, they changed the way that we fetch data in static websites:

Pages Router: Use getStaticProps() and getStaticPaths() in page files.
App Router: Use async/await in page.(js|jsx|ts|tsx) files.

All code snippets below provide examples for both the App Router and the Pages Router.

We recommend using the App Router for all new projects.

Perform a query

Queries are performed using a client created by the createClient() function exported from prismicio.js.

Here’s a complete example, querying a document of type page by its UID:

app/[uid]/page.jsx

import { createClient } from "@/prismicio";

export default async function Page({ params }) {
  const client = createClient();

  const page = await client.getByUID("page", params.uid);

  return <h1>{page.uid}</h1>;
}

In the Pages Router, createClient() receives the previewData object from getStaticProps(). This enables Prismic’s preview support. See Preview Drafts to learn more about setting up previews.

Caching with the App Router

Data fetching can be cached in the App Router using the cache and next parameters on the fetch() function. You can configure the Prismic client’s cache and next parameters using the fetchOptions parameter.

We recommend the following fetchOptions value for the best performance:

prismicio.js

  import * as prismic from '@prismicio/client'
  import * as prismicNext from '@prismicio/next'

  export const createClient = (config = {}) => {
    const client = prismic.createClient(repositoryName, {
      routes,
+     fetchOptions:
+       process.env.NODE_ENV === 'production'
+         ? { next: { tags: ['prismic'] }, cache: 'force-cache' }
+         : { next: { revalidate: 5 } },
        ...config,
    });

    prismicNext.enableAutoPreviews({ client })

    return client
  }

When your app is deployed, Prismic requests will be cached and tagged with "prismic". The tag allows for clearing Prismic queries from the fetch() caching using On-demand Revalidation. See the Deploy section for more details on setting up On-demand Revalidation.

While developing your app locally, Prismic requests will be cached for 5 seconds.

The cache and next parameters can be overridden on individual queries as needed.

const latestBlogPosts = await client.getAllByType(
  "blog_post",
  {
    fetchOptions: {
      cache: "no-store",
      next: { tags: ["prismic", "blog_posts"] },
    },
    limit: 3,
    orderings: [
      {
        field: "my.blog_post.published_on",
        direction: "desc",
      },
    ],
  },
);

Query helpers

Here are the most commonly-used query helper methods:

`getByUID()`

getByUID(type, uid);
getByUID(type, uid, params);

Queries a document from the Prismic repository with a UID and custom type. type refers to the API ID of the custom type.

const document = await client.getByUID(
  "post",
  "my-first-post",
);

`getSingle()`

getSingle(type);
getSingle(type, params);

Queries a singleton document from the Prismic repository for a specific custom type. type refers to the API ID of the custom type.

For example, here we are querying for the only document of the custom type homepage.

const document = await client.getSingle("homepage");

`getAllByType()`

getAllByType(type);
getAllByType(type, params);

Queries all documents from the Prismic repository for a specific custom type. type refers to the API ID of the custom type. This method may perform multiple network requests. It returns an array containing all matching documents from the repository.

const documents = await client.getAllByType("article");

Use cases

Here are a few common use cases.

Fetch linked data

To pull in content from another document, you must fetch that content in your API query using the graphQuery or fetchLinks option.

With fetchLinks, reference the linked custom type followed by the API ID of the specific field you want to retrieve. For example, if you have a custom type called blog that has a content relationship field that links to a custom type called author, and you want to retrieve the author_name field, your query would look like this:

app/blog/[uid]/page.js

import { createClient } from "@/prismicio";

export default async function Post() {
  const client = createClient();

  const blogPost = await client.getByUID(
    "blog",
    "my-blog-post",
    {
      fetchLinks: "author.author_name",
    },
  );

  return (
    <main>
      <h1>{blogPost.data.title}</h1>
      <em>{blogPost.data.author_link.data.author_name}</em>
    </main>
  );
}

Once you have adjusted your API query, the linked content will appear in a data object nested in the content relationship field:

"example_content_relationship": {
  "type": "author",
  "slug": "another-page-title",
  "uid": "jane-johnson",
  "data": {
    "author_name": "Jane Johnson"
  },
  "link_type": "Document",
  "isBroken": false
}

In Prismic, you can create a singleton custom type to store site components, like a header, footer, nav menu, or SEO configuration.

To query a singleton, use the getSingle() method with the API ID of the singleton custom type.

import { createClient } from "@/prismicio";
import { PrismicNextLink } from "@prismicio/next";

export default async function Page() {
  const client = createClient();

  const menu = await client.getSingle("menu");

  return (
    <ul>
      {menu.data.links.map((link) => (
        <li key={i}>
          <PrismicNextLink field={link.link}>
            {link.label}
          </PrismicNextLink>
        </li>
      ))}
    </ul>
  );
}

Query one instance of a repeatable document

On repeatable documents, we recommend adding a UID field — a unique identifier. Prismic formats each document’s UID so it is URL-friendly and unique to its custom type.

To query a specific document of a given custom type, like a blog post, you can use the getByUID() method. To use getByUID(), pass the UID and the API ID of the custom type.

app/hello-world/page.js

import { createClient } from "@/prismicio";

export default async function Page() {
  const client = createClient();

  const page = await client.getByUID("page", "hello-world");

  return <main>{page.data.title}</main>;
}

You will likely use getByUID() with a page’s URL path to generate a page based on the URL. For instance, at /hello-world, you would want to display the document with the UID hello-world. Rather than hard-coding every page by its UID, in Next.js you can use dynamic URL parameters by putting the parameter’s name in square brackets: pages/[uid].js. Then you can access the uid parameter and perform a query with it:

app/[uid]/page.js

import { createClient } from "@/prismicio";

export default async function Page({ params }) {
  const client = createClient();

  const page = await client.getByUID("page", params.uid);

  return <main>{page.data.title}</main>;
}

This will return a document dynamically, based on the URL, so you can template a repeatable document.

Query all documents

You can query all documents of a certain type with getAllByType().

This method is most often used within a page’s generateStaticParams() or getStaticPaths().

app/page.js

import { createClient } from "@/prismicio";

export async function generateStaticParams() {
  const client = createClient();

  const pages = await client.getAllByType("page");

  return pages.map((page) => {
    return { uid: page.uid };
  });
}

Query by language

Prismic allows you to publish your content in different languages. By default, the API will return content in your master language. To get content in a different language, add an options object with a lang option and a locale code. Here’s an example of how to query the document of the type homepage in French (fr-fr).