Watch a live product demo 👀 See how Sanity powers richer commerce experiences

How to Query a Public API Endpoint and Pull Metadata into a Document

2 replies
Last updated: Apr 19, 2022
Learning Sanity - going through the docs. I’m looking to build a new CMS for my company strictly to enable marketing teams. Is it possible to query a public API endpoint and pull in metadata into a document? Example; lets say our writers will be writing about SKU #11; i’d like to query our product API and pull in the metadata (name, price, launch date, faculty name, etc) and be able to use those variables inside the content - or pre-render them as default values. Is this possible?
Apr 18, 2022, 6:07 PM
user Y
That would be awesome. Glad to hear it might be possible. Going to continue to dig into things.
Apr 18, 2022, 6:36 PM
As some more follow up
user B
, you would more or less want to hit the endpoint with the data you are looking for, then iterate over the data and then queue up your changes. Then you would define your document fields inside of an object called
, then use the client to write those changes.

Here is an example of a script that one of my colleagues Racheal put together that although isn’t directly using an external API it is similar in process using the
API to fetch info, iterate over it then create documents from that info. This should at least give you a working example of what you are asking for:

import { studioClient } from "./studioClient"
import cq from 'concurrent-queue'
import userStore from 'part:@sanity/base/user'

// Create a queue to limit the rate at which you write changes to Sanity
let queue = cq().limit({ concurrency: 2 }).process(function (task) {
  return new Promise(function (resolve, reject) {
      setTimeout(resolve.bind(undefined, task), 1000)

const createUserDocuments = async () => {
  const allUsers = await studioClient
    .fetch(`*[_id in path('_.groups.*')].members[@ != 'everyone']`)
    .then(res => userStore.getUsers(res))
    .then(users => users.filter(user => user.isCurrentUser))

    for (const user of allUsers){
      const doc = {
        _type: 'person',
        name: user.displayName,
        //other fields you have in your schema
      queue(doc).then(async () => {
        //create the doc via the client
          .then(updatedDoc => {
            console.log(`Hurray, the doc is updated! New document:${updatedDoc._id}`)
          .catch((err) => {
            console.error('Oh no, the update failed: ', err.message)


// execute this script by running 
// $ sanity exec ./path-to-your-script --withUserToken --mock-browser-env

here is a link in our docs to some additional information around creating documents (although vaguely related it is not exactly what you are asking for, it is very helpful for getting a better grasp of how creating documents works and different use cases). with these docs and the examples provided that should get you where you need to go.
Apr 19, 2022, 6:44 PM – build remarkable experiences at scale

Sanity is a customizable solution that treats content as data to power your digital business. Free to get started, and pay-as-you-go on all plans.

Related answers

Get more help in the community Slack

TopicCategoriesFeaturedRepliesLast Updated
After adding the subtitle and running this code npm run graphql-deploy It does nothingSep 15, 2020
how to limit a reference to just one entry in Studio reference input side versus the default as-many-entries-as-you-fill-in-an-array...Sep 18, 2020
Is it possible to fetch more than one "_type" using GROQ?Nov 2, 2020
I want to add a view with the Structure builder (S.view.component) where I list similar documents based on the title. What...Sep 23, 2020
Is there a structure builder example where the format of each preview for the document list is modified?Feb 3, 2021
I have an array of references to a country schema type but it always just returns NULL values for meJan 30, 2021
Hi, I need help with a query for getting the url of an image asset. Here is what I've been trying, but I only get the _ref...Dec 1, 2020
Sanity UI looks brilliant :smiley: Is something like the current date picker possible at the moment? I’m not sure if anicon...Dec 21, 2020
Hey everyone. I have been coding and may have potentially accidentally deleted something. Does anyone know how to resolve...Dec 26, 2020
Hello everyone and happy new year :raised_hands::skin-tone-2:, I have a problem with outputting Portable Text :disappointed:...Jan 1, 2021

Related contributions

Clean Next.js + Sanity app
- Template

Official(made by Sanity team)

A clean example of Next.js with embedded Sanity ready for recomposition.

Cody Olsen
Go to Clean Next.js + Sanity app

Blog with Built-in Content Editing
- Template

Official(made by Sanity team)

A Sanity-powered blog with built-in content editing and instant previews.

Go to Blog with Built-in Content Editing