Marketplace

Contentstack Marketplace is a hub for apps and other resources that help you extend the capabilities of our core CMS and customize its functionalities. It houses third-party integrations, UI extensions (such as dashboard, sidebar, custom field, and RTE plugins), and other tools that you can plug into Contentstack at the stack as well as organizational level.

Example:

import * as contentstack from '@contentstack/marketplace-sdk'

client.marketplace('organization_uid');

Name	Type	Description
org_uid (required)	String	UID of the organization

app

The app method creates and retrieves a new instance of the App class with the given parameters.

Name	Type	Description
manifest_uid	String	UID of the app

Example:

import * as contentstack from '@contentstack/marketplace-sdk'

const client = contentstack.client({ authtoken: 'TOKEN'});

client.marketplace('organization_uid').app('manifest_uid');

installation

The installation method allows you to retrieve, update and delete the app installation.

Name	Type	Description
uid	String	UID for the installation

Example 1:

import * as contentstack from '@contentstack/marketplace-sdk'

const client = contentstack.client({ authtoken: 'TOKEN'});

client.organization('organization_uid').app('manifest_uid').installation().findAll()

.then((installations) => console.log(installations));

Example 2:

import * as contentstack from '@contentstack/marketplace-sdk'

const client = contentstack.client({ authtoken: 'TOKEN'});

client.marketplace('organization_uid').installation('installation_uid').fetch()

.then((installation) => console.log(installation));

appRequests

The appRequests method creates an app request for the app.

Example:

import * as contentstack from '@contentstack/marketplace-sdk'

const client = contentstack.client({ authtoken: 'TOKEN'});

client.marketplace('organization_uid').appRequests();

findAllApps

The findAllApps method retrieves all the apps in your organization.

Example:

import * as contentstack from '@contentstack/marketplace-sdk'

const client = contentstack.client({ authtoken: 'TOKEN'});

client.marketplace('organization_uid').findAllApps()

.then((collection) => console.log(collection));

findAllAuthorizedApps

The findAllAuthorizedApps method retrieves all the authorized apps for the organization.

Name	Type	Description
skip	number	Offset for skipping content in response
limit	number	Limit on API response to provide content in the list

Example:

import * as contentstack from '@contentstack/marketplace-sdk'

const client = contentstack.client();

client.marketplace('organization_uid').findAllAuthorizedApps({ skip: 10 })

.then((roles) => console.log(roles));

searchApps

The searchApps method lets you find Marketplace apps in your Contentstack organization by name.

Name	Type	Description
search (required)	String	The app name or keyword to search for.
sort	String	Field to sort the results (eg. created_at, updated, at)
target_type	['stack'] or ['organization']	Specify whether your app is a stack app or an organization app
order	String	The order in which the response is given
limit	Number	Limit on API response to provide content in the list
skip	Number	Offset for skipping content in response

Example 1:

import * as contentstack from '@contentstack/marketplace-sdk'
const client = contentstack.client({ authtoken: 'TOKEN' });
const search = 'appname'
client.marketplace('organization_uid')
  .searchApps(search)
  .then((collection) => console.log(collection))
  .catch((error) => console.error(error));

Example 2:

import * as contentstack from '@contentstack/marketplace-sdk'
const client = contentstack.client({ authtoken: 'TOKEN' });
client.marketplace('organization_uid')
  .searchApps('mp app name', {
    order: 'desc',
    sort: 'created_at',
    target_type: 'field'
  })
  .then((collection) => console.log(collection))
  .catch((error) => console.error(error));