Notice something different? Get the story behind our exciting new brand
Contentstack
search
Changelog

Contentstack - JavaScript Management SDK

JavaScript Management SDK for Contentstack

Prerequisite

Setup and Installation

For Node.js

Quickstart in 5 mins

Initializing Your SDK

Authentication

Fetch Stack Detail

Create Entry

Create Asset

Contentstack

Contentstack

Returns:
Type
ContentstackClient

ContentstackClient

login

Returns:
Type
Promise

getUser

Returns:
Type
Promise

logout

Returns:
Type
Organization

stack

Returns:
Type
Promise

organization

Returns:
Type
Organization

User

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

requestPassword

Returns:
Type
Promise

resetPassword

Returns:
Type
Promise

getTasks

Returns:
Type
Promise

Organization

fetch

Returns:
Type
Promise

stacks

Returns:
Type
Promise

addUser

Returns:
Type
Promise

transferOwnership

Returns:
Type
Promise

getInvitations

Returns:
Type
Promise

resendInvitition

Returns:
Type
Promise

roles

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

organization

Returns:
Type
Organization

Stack

update

Returns:
Type
Promise

fetch

Returns:
Type
Promise

contentType

Returns:
Type
ContentType

locale

Returns:
Type
Locale

asset

Returns:
Type
Asset

globalField

Returns:
Type
GlobalField

environment

Returns:
Type
Environment

branch

Returns:
Type
Branch

branchAlias

Returns:
Type
BranchAlias

deliveryToken

Returns:
Type
DeliveryToken

extension

Returns:
Type
Extension

workflow

Returns:
Type
workflow

webhook

Returns:
Type
Webhook

label

Returns:
Type
Label

release

Returns:
Type
Release

bulkOperation

Returns:
Type
BulkOperation

users

Returns:
Type
Promise

updateUsersRoles

Returns:
Type
Promise

transferOwnership

Returns:
Type
Promise

settings

Returns:
Type
Promise

resetSettings

Returns:
Type
Promise

addSettings

Returns:
Type
Promise

share

Returns:
Type
Promise

unShare

Returns:
Type
Promise

role

Returns:
Type
Role

create

Returns:
Type
Promise

query

Returns:
Type
Query

auditlog

Returns:
Type
AuditLog

ContentType

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

entry

Returns:
Type
Entry

generateUid

Returns:
Type
string

create

Returns:
Type
Promise

query

Returns:
Type
Promise

import

Returns:
Type
Promise

GlobalField

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Query

import

Returns:
Type
Promise

Entry

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

publish

Returns:
Type
Promise

unpublish

Returns:
Type
Promise

publishRequest

Returns:
Type
Promise

setWorkflowStage

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Promise

import

Returns:
Type
Promise

Asset

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

replace

Returns:
Type
Promise

publish

Returns:
Type
Promise

unpublish

Returns:
Type
Promise

folder

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Promise

download

Returns:
Type
Promise

Branch

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Promise

compare all

Returns:
Type
Promise

compare contentType

Returns:
Type
Promise

compare globalField

Returns:
Type
Promise

merge

Returns:
Type
Promise

fetch mergeQueue

Returns:
Type
Promise

find mergeQueue

Returns:
Type
Promise

BranchAlias

createOrUpdate

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

Folder

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

BulkOperation

publish

Returns:
Type
Promise

unpublish

Returns:
Type
Promise

delete

Returns:
Type
Promise

addItems

Returns:
Type
Promise

updateItems

Returns:
Type
Promise

jobStatus

Returns:
Type
Promise

Extension

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

upload

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Promise

Release

update

Returns:
Type
Promise

fetch

Returns:
Type
Promise

delete

Returns:
Type
Promise

item

Returns:
Type
ReleaseItem

deploy

Returns:
Type
Promise

clone

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Promise

ReleaseItem

delete

Returns:
Type
Promise

create

Returns:
Type
Promise

findAll

Returns:
Type
Promise

move

Returns:
Type
Promise

Labels

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Query

Locale

update

Returns:
Type
Promise.<Locale.Locale>

delete

Returns:
Type
Object

fetch

Returns:
Type
Promise.<Locale.Locale>

create

Returns:
Type
Promise.<Locale.Locale>

query

Returns:
Type
Array.<Locale>

AuditLog

fetch

Returns:
Type
Promise.<Branch.Branch>

fetchAll

Returns:
Type
ContentstackCollection

Environment

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Query

DeliveryToken

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Query

ManagementToken

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

query

Returns:
Type
Query

Role

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

create

Returns:
Type
Promise

fetch

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

query

Returns:
Type
Query

Webhook

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

executions

Returns:
Type
Promise

retry

Returns:
Type
Promise

create

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

import

Returns:
Type
Promise

Workflow

update

Returns:
Type
Promise

disable

Returns:
Type
Promise

enable

Returns:
Type
Promise

delete

Returns:
Type
Promise

fetch

Returns:
Type
Promise

getPublishRules

Returns:
Type
Promise

create

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

publishRule

Returns:
Type
Promise

PublishRules

create

Returns:
Type
Promise

Taxonomy

create

Returns:
Type
Promise

fetch

Returns:
Type
Promise

query

Returns:
Type
Promise

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

Terms

create

Returns:
Type
Promise

fetch

Returns:
Type
Promise

query

Returns:
Type
Promise

update

Returns:
Type
Promise

delete

Returns:
Type
Promise

ancestors

Returns:
Type
Promise

descendants

Returns:
Type
Promise

move

Returns:
Type
Promise
Returns:
Type
Promise

Teams

fetch

Returns:
Type
Promise

create

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

delete

Returns:
Type
Promise

update

Returns:
Type
Promise

TeamUsers

Returns:
Type
teamUsers

stackRoleMappings

Returns:
Type
stackRoleMappings

TeamUsers

add

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

remove

Returns:
Type
Promise

StackRoleMappings

add

Returns:
Type
Promise

fetchAll

Returns:
Type
Promise

delete

Returns:
Type
Promise

update

Returns:
Type
Promise

Variant Group

Create variant group

Returns:
Type
Promise

Update variant group

Returns:
Type
Promise

Delete variant group

Returns:
Type
Promise

Get all variant group (For Stack and ContentType)

Returns:
Type
Promise

Variant

Create variant

Returns:
Type
Promise

Update variant

Returns:
Type
Promise

Delete variant

Returns:
Type
Promise

Get a single variant

Returns:
Type
Promise

Create variant

Returns:
Type
Promise

Ungrouped Variant

Create variant

Returns:
Type
Promise

Delete variant

Returns:
Type
Promise

Get a single variant

Returns:
Type
Promise

Get all variant

Returns:
Type
Promise

Get variants by UIDs

Returns:
Type
Promise

Entry Variant

Get all entry variants

Returns:
Type
Promise

Get a single entry variant

Returns:
Type
Promise

Delete entry variant

Returns:
Type
Promise

Update entry variant

Returns:
Type
Promise