Queries

Use a GraphQL query when you need to retrieve data from the server. GraphQL queries are comparable to GET requests in REST APIs. When forming a query, as well as the query name you must specify the output object in the correct format by using nested subfields until you return only scalars. GraphQL queries return only the data you specify. The available fields for each query are defined in the query's Type section and are detailed under Objects. Some queries also require arguments to be specified.

Assets

viewer

Retrieve the current user or API client

See also: Concepts: viewer, media hubs and repositories

viewer: User

Returns: User

node

node(
  id: ID!
): Node

Returns: Node

Arguments:

Argument	Type	Default	Description
id	ID!

asset

asset(
  id: ID!
): Asset

Returns: Asset

Arguments:

Argument	Type	Default	Description
id	ID!

assets

Retrieve multiple assets by their ID

See also: Examples: getting an asset by ID

assets(
  id: [ID!]
  assetId: [String!]
): AssetSearchConnection!

Returns: AssetSearchConnection!

Arguments:

Argument	Type	Default	Description
id	[ID!]		ID of the assets
assetId	[String!]		UUID of the assets

assetSearch

Asset Search Query

See also: Asset search conventions

assetSearch(
  keyword: String = "*"
  fields: [SearchableFields!]
  filters: FilterFields
  sort: SortableFields
  before: String
  after: String
  first: Int
  last: Int
): AssetSearchConnection!

Returns: AssetSearchConnection!

Arguments:

Argument	Type	Default	Description
keyword	String	"*"	Terms or phrases to search for. A term is a single word. A phrase is a group of words enclosed in double quotes. Quotes must be escaped in the GraphQL query using a backslash e.g. "\"Darth Vader\"". The wildcard character * can be used e.g. "Darth " to return "Darth Vader, Darth Sidious, Darth Maul". "" cannot be used at the start of a term or phrase, as this has a negative performance impact. The following boolean operators are supported: AND OR NOT + -. Parentheses can be used to form sub-queries e.g. "(red* OR green*) AND XS_*". MaxLength of keyword: 1000
fields	[SearchableFields!]		Fields to search against - restricts the fields the keyword search applies to. Defaults to search against all SearchableFields if not supplied
filters	FilterFields		Filter results based on the field values
sort	SortableFields		Fields to sort asset search results by. When a sort is supplied in case of a tie break the default sort is applied after the specified sort.If a sort is not supplied the default will be applied. The default sort is score desc, ID desc.
before	String		Cursor to start from when paginating backwards
after	String		Cursor to start from when paginating forwards
first	Int		Specifies the number of results to return. Required when after cursor is used. Cannot be used with before cursor. Defaults to 20 results if not supplied.
last	Int		Specifies the number of results to return when paginating backwards. Must be used with before cursor.

assetFolder

assetFolder(
  id: ID!
): AssetFolder

Returns: AssetFolder

Arguments:

Argument	Type	Default	Description
id	ID!

assetRepository

assetRepository(
  id: ID!
): AssetRepository

Returns: AssetRepository

Arguments:

Argument	Type	Default	Description
id	ID!

assetUpdatedResponse

assetUpdatedResponse(
  id: ID!
): AssetUpdatedResponse

Returns: AssetUpdatedResponse

Arguments:

Argument	Type	Default	Description
id	ID!

createFolderResponse

createFolderResponse(
  id: ID!
): CreateFolderResponse

Returns: CreateFolderResponse

Arguments:

Argument	Type	Default	Description
id	ID!

updateAssetMetadataResponse

updateAssetMetadataResponse(
  id: ID!
): UpdateAssetMetadataResponse

Returns: UpdateAssetMetadataResponse

Arguments:

Argument	Type	Default	Description
id	ID!

Media hub

mediaHub

mediaHub(
  id: ID!
): MediaHub

Returns: MediaHub

Arguments:

Argument	Type	Default	Description
id	ID!

videoTranscodingProfile

See also: Examples: listing transcoding profiles

videoTranscodingProfile(
  id: ID!
): VideoTranscodingProfile

Returns: VideoTranscodingProfile

Arguments:

Argument	Type	Default	Description
id	ID!

virtualStagingEnvironment

virtualStagingEnvironment(
  id: ID!
): VirtualStagingEnvironment

Returns: VirtualStagingEnvironment

Arguments:

Argument	Type	Default	Description
id	ID!

Organization & users

organization

organization(
  id: ID!
): Organization

Returns: Organization

Arguments:

Argument	Type	Default	Description
id	ID!

user

user(
  id: ID!
): User

Returns: User

Arguments:

Argument	Type	Default	Description
id	ID!

team

team(
  id: ID!
): Team

Returns: Team

Arguments:

Argument	Type	Default	Description
id	ID!

invitation

invitation(
  id: ID!
): Invitation

Returns: Invitation

Arguments:

Argument	Type	Default	Description
id	ID!

personalAccessToken

See also: Examples: personal access tokens

personalAccessToken(
  id: ID!
): PersonalAccessToken

Returns: PersonalAccessToken

Arguments:

Argument	Type	Default	Description
id	ID!

CMS

cmsHub

cmsHub(
  id: ID!
): CMSHub

Returns: CMSHub

Arguments:

Argument	Type	Default	Description
id	ID!

cmsRepository

cmsRepository(
  id: ID!
): CMSRepository

Returns: CMSRepository

Arguments:

Argument	Type	Default	Description
id	ID!

Commerce

bigCommerceCommerceProduct

bigCommerceCommerceProduct(
  id: ID!
): BigCommerceCommerceProduct

Returns: BigCommerceCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

bigCommerceCommerceCategory

bigCommerceCommerceCategory(
  id: ID!
): BigCommerceCommerceCategory

Returns: BigCommerceCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

bigCommerceCommerceRepository

bigCommerceCommerceRepository(
  id: ID!
): BigCommerceCommerceRepository

Returns: BigCommerceCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

shopifyCommerceProduct

shopifyCommerceProduct(
  id: ID!
): ShopifyCommerceProduct

Returns: ShopifyCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

shopifyCommerceCategory

shopifyCommerceCategory(
  id: ID!
): ShopifyCommerceCategory

Returns: ShopifyCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

shopifyCommerceRepository

shopifyCommerceRepository(
  id: ID!
): ShopifyCommerceRepository

Returns: ShopifyCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

salesforceCommerceProduct

salesforceCommerceProduct(
  id: ID!
): SalesforceCommerceProduct

Returns: SalesforceCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

salesforceCommerceCategory

salesforceCommerceCategory(
  id: ID!
): SalesforceCommerceCategory

Returns: SalesforceCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

salesforceCommerceRepository

salesforceCommerceRepository(
  id: ID!
): SalesforceCommerceRepository

Returns: SalesforceCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

commercetoolsCommerceProduct

commercetoolsCommerceProduct(
  id: ID!
): CommercetoolsCommerceProduct

Returns: CommercetoolsCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

commercetoolsCommerceCategory

commercetoolsCommerceCategory(
  id: ID!
): CommercetoolsCommerceCategory

Returns: CommercetoolsCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

commercetoolsCommerceRepository

commercetoolsCommerceRepository(
  id: ID!
): CommercetoolsCommerceRepository

Returns: CommercetoolsCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

scayleCommerceProduct

scayleCommerceProduct(
  id: ID!
): ScayleCommerceProduct

Returns: ScayleCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

scayleCommerceCategory

scayleCommerceCategory(
  id: ID!
): ScayleCommerceCategory

Returns: ScayleCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

scayleCommerceRepository

scayleCommerceRepository(
  id: ID!
): ScayleCommerceRepository

Returns: ScayleCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

jsonFileFeedCommerceProduct

jsonFileFeedCommerceProduct(
  id: ID!
): JsonFileFeedCommerceProduct

Returns: JsonFileFeedCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

jsonFileFeedCommerceCategory

jsonFileFeedCommerceCategory(
  id: ID!
): JsonFileFeedCommerceCategory

Returns: JsonFileFeedCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

jsonFileFeedCommerceRepository

jsonFileFeedCommerceRepository(
  id: ID!
): JsonFileFeedCommerceRepository

Returns: JsonFileFeedCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

xmlFileFeedCommerceProduct

xmlFileFeedCommerceProduct(
  id: ID!
): XmlFileFeedCommerceProduct

Returns: XmlFileFeedCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

xmlFileFeedCommerceCategory

xmlFileFeedCommerceCategory(
  id: ID!
): XmlFileFeedCommerceCategory

Returns: XmlFileFeedCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

xmlFileFeedCommerceRepository

xmlFileFeedCommerceRepository(
  id: ID!
): XmlFileFeedCommerceRepository

Returns: XmlFileFeedCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

csvFileFeedCommerceProduct

csvFileFeedCommerceProduct(
  id: ID!
): CsvFileFeedCommerceProduct

Returns: CsvFileFeedCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

csvFileFeedCommerceCategory

csvFileFeedCommerceCategory(
  id: ID!
): CsvFileFeedCommerceCategory

Returns: CsvFileFeedCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

csvFileFeedCommerceRepository

csvFileFeedCommerceRepository(
  id: ID!
): CsvFileFeedCommerceRepository

Returns: CsvFileFeedCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

googleProductFeedCommerceProduct

googleProductFeedCommerceProduct(
  id: ID!
): GoogleProductFeedCommerceProduct

Returns: GoogleProductFeedCommerceProduct

Arguments:

Argument	Type	Default	Description
id	ID!

googleProductFeedCommerceCategory

googleProductFeedCommerceCategory(
  id: ID!
): GoogleProductFeedCommerceCategory

Returns: GoogleProductFeedCommerceCategory

Arguments:

Argument	Type	Default	Description
id	ID!

googleProductFeedCommerceRepository

googleProductFeedCommerceRepository(
  id: ID!
): GoogleProductFeedCommerceRepository

Returns: GoogleProductFeedCommerceRepository

Arguments:

Argument	Type	Default	Description
id	ID!

Content generation

contentGenerationModel

contentGenerationModel(
  id: ID!
): ContentGenerationModel

Returns: ContentGenerationModel

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationAudience

contentGenerationAudience(
  id: ID!
): ContentGenerationAudience

Returns: ContentGenerationAudience

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationBrandVoice

contentGenerationBrandVoice(
  id: ID!
): ContentGenerationBrandVoice

Returns: ContentGenerationBrandVoice

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationTone

contentGenerationTone(
  id: ID!
): ContentGenerationTone

Returns: ContentGenerationTone

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationJob

contentGenerationJob(
  id: ID!
): ContentGenerationJob

Returns: ContentGenerationJob

Arguments:

Argument	Type	Default	Description
id	ID!

contentFlow

contentFlow(
  id: ID!
): ContentFlow

Returns: ContentFlow

Arguments:

Argument	Type	Default	Description
id	ID!

contentFlowRun

contentFlowRun(
  id: ID!
): ContentFlowRun

Returns: ContentFlowRun

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationSessionMessage

contentGenerationSessionMessage(
  id: ID!
): ContentGenerationSessionMessage

Returns: ContentGenerationSessionMessage

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationSession

contentGenerationSession(
  id: ID!
): ContentGenerationSession

Returns: ContentGenerationSession

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationBriefTemplate

contentGenerationBriefTemplate(
  id: ID!
): ContentGenerationBriefTemplate

Returns: ContentGenerationBriefTemplate

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationExample

contentGenerationExample(
  id: ID!
): ContentGenerationExample

Returns: ContentGenerationExample

Arguments:

Argument	Type	Default	Description
id	ID!

contentGenerationExampleFolder

contentGenerationExampleFolder(
  id: ID!
): ContentGenerationExampleFolder

Returns: ContentGenerationExampleFolder

Arguments:

Argument	Type	Default	Description
id	ID!

Content review

contentReview

contentReview(
  id: ID!
): ContentReview

Returns: ContentReview

Arguments:

Argument	Type	Default	Description
id	ID!

contentReviewTask

contentReviewTask(
  id: ID!
): ContentReviewTask

Returns: ContentReviewTask

Arguments:

Argument	Type	Default	Description
id	ID!

Extensions

extension

extension(
  id: ID!
): Extension

Returns: Extension

Arguments:

Argument	Type	Default	Description
id	ID!

extensionRelease

extensionRelease(
  id: ID!
): ExtensionRelease

Returns: ExtensionRelease

Arguments:

Argument	Type	Default	Description
id	ID!

extensionInstance

extensionInstance(
  id: ID!
): ExtensionInstance

Returns: ExtensionInstance

Arguments:

Argument	Type	Default	Description
id	ID!

AI & media tools

transformationTemplate

transformationTemplate(
  id: ID!
): TransformationTemplate

Returns: TransformationTemplate

Arguments:

Argument	Type	Default	Description
id	ID!

previewKey

previewKey(
  id: ID!
): PreviewKey

Returns: PreviewKey

Arguments:

Argument	Type	Default	Description
id	ID!

webhookListener

webhookListener(
  id: ID!
): WebhookListener

Returns: WebhookListener

Arguments:

Argument	Type	Default	Description
id	ID!

magicEraseImageJob

magicEraseImageJob(
  id: ID!
): MagicEraseImageJob

Returns: MagicEraseImageJob

Arguments:

Argument	Type	Default	Description
id	ID!