GraphQL

API reference Examples Playground

Live

All domains

DAM

Assets

Overview

Queries

asset
assets

Mutations

addAssetMetadataFieldValue
addAssetPreviewImage
addAssetRelations
addAssetTags
createAsset
createAssetVariant
createAssetWorkflowTask
createAttachment
createExternalAsset
deleteAsset
deleteAssetVariant
deleteAttachment
moveAssets
removeAssetPreviewImage
removeAssetRelations
removeAssetTags
replaceAsset
replaceAssetVariant
syncAssetTags
updateAsset
updateAssets
uploadFile

Collaborators

Overview

Mutations

inviteProjectUser

Collections

Overview

Mutations

addCollectionAssets
createCollection
deleteCollection
removeCollectionAssets
setCollectionAssets
updateCollection

Comments

Overview

Mutations

createAssetComment
deleteComment
editComment
reopenAssetComment
replyToComment
resolveAssetComment

Folders

Overview

Mutations

createFolder
deleteFolders
moveFolders
updateFolder

Libraries

Overview

Queries

library
project

Licenses & copyright

Overview

Mutations

addAssetLicense
createLicense
deleteLicense
removeAssetLicense

Metadata

Overview

Mutations

addCustomMetadata
addCustomMetadataPropertyOptions
createCustomMetadataProperty
createMetadataField
deleteCustomMetadataProperty
deleteMetadataField
removeCustomMetadata
removeCustomMetadataPropertyOptions
removeMetadataValue
setCustomMetadata
updateCustomMetadataProperty

Workflows

Overview

Mutations

addWorkflowChecklistItem
addWorkflowChecklistPreset
addWorkflowStatusAssignees
addWorkflowTaskAssignees
createWorkflowStatus
deleteWorkflowStatus
deleteWorkflowTask
moveWorkflowTask
removeWorkflowChecklistItem
removeWorkflowChecklistPreset
removeWorkflowStatusAssignees
removeWorkflowTaskAssignees
updateWorkflowChecklistItem
updateWorkflowChecklistPreset
updateWorkflowStatus
updateWorkflowTask

Workspace

Overview

Queries

workspaceProject

Mutations

createWorkspaceProject

Account

Overview

Queries

account

Catalogs

Overview

Queries

catalog
catalogSelection

Mutations

clearCatalogColumn
clearCatalogRow
createCatalog
createCatalogColumn
createCatalogRow
duplicateCatalogColumn
duplicateCatalogRow
ingestCatalogRows
moveCatalogColumn
moveCatalogRow
removeCatalog
removeCatalogColumns
removeCatalogRows
setCatalogCells
setCatalogColumnAsPrimary
updateCatalog
updateCatalogColumn

Search

Overview

Targets

Overview

Mutations

addLibraryAssetTargets
removeLibraryAssetTargets
setLibraryAssetTargets

Users

Overview

Queries

currentUser

Brand

Brand Essentials

Overview

Brands

Overview

Queries

brand
brands

Mutations

createBrand
deleteBrand
updateBrand

Creative Templates

Overview

Queries

creativeExport
creativeTemplate

Mutations

cancelExportCreatives
exportCreative

Guidelines

Overview

Queries

guidelineNavigationItem
guidelinePage
guidelinePageBlock

Mutations

changeDefaultColorScheme
createColorScheme
createGuidelineDocument
createGuidelineDocumentGroup
createGuidelineDocumentLibrary
createGuidelineDocumentLink
createGuidelineDocumentPage
createGuidelineDocumentPageCategory
createGuidelineDocumentPageLink
createGuidelinePageBlock
createGuidelinePageHeading
createGuidelinePageSection
deleteColorScheme
deleteGuidelineDocument
deleteGuidelineDocumentGroup
deleteGuidelineDocumentLibrary
deleteGuidelineDocumentLink
deleteGuidelineDocumentPage
deleteGuidelineDocumentPageCategory
deleteGuidelineDocumentPageLink
deleteGuidelinePageHeading
deleteGuidelinePageSection
duplicateColorScheme
duplicateGuidelineDocumentPage
hideGuidelineDocumentFromNavigation
hideGuidelineDocumentGroupFromNavigation
hideGuidelineDocumentLibraryFromNavigation
hideGuidelineDocumentPageFromNavigation
moveGuidelineDocumentPage
publishGuidelineDocumentPage
showGuidelineDocumentGroupInNavigation
showGuidelineDocumentInNavigation
showGuidelineDocumentLibraryInNavigation
showGuidelineDocumentPageInNavigation
unpublishGuidelineDocumentPage
updateColorScheme
updateGuidelineDesignSettingsAccentColor
updateGuidelineDesignSettingsBackgroundColor
updateGuidelineDesignSettingsBulletListStyleColors
updateGuidelineDesignSettingsBulletListStyles
updateGuidelineDesignSettingsButtonStyle
updateGuidelineDesignSettingsButtonStyleColor
updateGuidelineDesignSettingsMainFontFamily
updateGuidelineDesignSettingsNumberedListStyleColors
updateGuidelineDesignSettingsNumberedListStyles
updateGuidelineDesignSettingsTypeStyle
updateGuidelineDesignSettingsTypeStyleColor
updateGuidelineDocument
updateGuidelineDocumentGroup
updateGuidelineDocumentLibrary
updateGuidelineDocumentLink
updateGuidelineDocumentPage
updateGuidelineDocumentPageCategory
updateGuidelineDocumentPageLink
updateGuidelinePageBlockSettings
updateGuidelinePageHeading
updateGuidelinePageSection

Development

Marketplace

Overview

Mutations

publishMarketplaceApp

Node

Overview

Queries

node

Scalars

Overview

Service Apps

Overview

Queries

serviceApps

Mutations

createServiceApp
deleteServiceApp

Webhooks

Overview

Queries

webhooks

Mutations

configureProjectWebhook
installProjectWebhook
uninstallWebhook

Domains / Scalars

Scalars

Markdown

Shared scalar types used across the GraphQL API.

Scalars8

Any
BigInt
DateTime
Email
JsonObject
Percent
RgbColorChannel
Url