Skip to main content
Version: 3.x

App

Represents app data.

type App implements Node, ObjectWithMetadata {
id: ID!
privateMetadata: [MetadataItem!]!
privateMetafield(key: String!): String
privateMetafields(keys: [String!]): Metadata
metadata: [MetadataItem!]!
metafield(key: String!): String
metafields(keys: [String!]): Metadata
permissions: [Permission!]
created: DateTime
isActive: Boolean
name: String
type: AppTypeEnum
tokens: [AppToken!]
webhooks: [Webhook!]
aboutApp: String
dataPrivacy: String
dataPrivacyUrl: String
homepageUrl: String
supportUrl: String
configurationUrl: String
appUrl: String
manifestUrl: String
version: String
accessToken: String
extensions: [AppExtension!]!
}

Fields

id (ID!)

privateMetadata ([MetadataItem!]!)

List of private metadata items. Requires staff permissions to access.

privateMetafield (String)

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

privateMetafields (Metadata)

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metadata ([MetadataItem!]!)

List of public metadata items. Can be accessed without permissions.

metafield (String)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

permissions ([Permission!])

List of the app's permissions.

created (DateTime)

The date and time when the app was created.

isActive (Boolean)

Determine if app will be set active or not.

name (String)

Name of the app.

type (AppTypeEnum)

Type of the app.

tokens ([AppToken!])

Last 4 characters of the tokens.

Requires one of the following permissions: MANAGE_APPS, OWNER.

webhooks ([Webhook!])

List of webhooks assigned to this app.

Requires one of the following permissions: MANAGE_APPS, OWNER.

aboutApp (String)

Description of this app.

dataPrivacy (String)

Description of the data privacy defined for this app.

dataPrivacyUrl (String)

URL to details about the privacy policy on the app owner page.

homepageUrl (String)

Homepage of the app.

supportUrl (String)

Support page for the app.

configurationUrl (String)

URL to iframe with the configuration for the app.

appUrl (String)

URL to iframe with the app.

manifestUrl (String)

URL to manifest used during app's installation.

Added in Saleor 3.5.

version (String)

Version number of the app.

accessToken (String)

JWT token used to authenticate by thridparty app.

extensions ([AppExtension!]!)

App's dashboard extensions.

Added in Saleor 3.1.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

Interfaces

Node

An object with an ID

ObjectWithMetadata