Get Started with NodeJS SDK

This guide will help you get started with Contentstack Node.js SDK to build apps powered by Contentstack.


To get started with Node.js, you will need the following:

  • Node.js version 4.4.7 or later

SDK Installation and Setup

Contentstack offers two regions (US and European) as data centers to store customers' account details and data. Both regions are independent of each other and therefore have a dedicated set of instructions to use SDKs offered by Contentstack.

To use SDKs for the European region, you will have to make certain changes in the configuration of the SDK, as detailed below, and the rest of the instructions remain the same.

Open the terminal and install the contentstack module via the ‘npm’ command.

$ npm install contentstack --save

To use the module in your application, you need to require the ‘contentstack’ module.

import * as Contentstack from 'contentstack';

Initialize SDK

To initialize the SDK, specify the stack’s API key, delivery token, and name of the environment where you have published the content.

// Initialize the Contentstack Stack
const Stack = Contentstack.Stack("api_key", "delivery_token", "environment_name");

For Setting the European Region:

If you want to set and use European region, refer to the code below:

const Stack = new Contentstack({ 'api_key': "", 'access_token': "", 'environment': "", "region": Contentstack.Region.EU})

Once you have initialized the SDK, you can start getting content in your app.

Basic Queries

Get a Single Entry

To get a single entry, you need to specify the content type as well as the id of the entry.

const Query = Stack.ContentType('blog').Entry("blta464e9fbd048668c")
   .then(function success(entry) {
       console.log(entry.get('title')); // Retrieve field value by providing a field's uid
       console.log(entry.toJSON()); // Convert the entry result object to JSON
   }, function error(err) {
       // err object

Get Multiple Entries

To retrieve multiple entries of a content type, specify the content type UID. You can also specify search parameters to filter results.

const Query = Stack.ContentType('blog').Query();
   .where("title", "welcome")
   .then(function success(result) {
      // result is array where -
      // result[0] => entry objects
      // result[result.length-1] => entry objects count included only when .includeCount() is queried.
      // result[1] => schema of the content type is included when .includeSchema() is queried.
  }, function error(err) {
     // err object

These were the examples of some of the basic queries of the NodeJS SDK. For advanced queries, refer to Contentstack NodeJS API reference.

More articles in "Use NodeJS SDK"

On This Page