App Object

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
  identifier: String
  permissions: [Permission!]
  created: DateTime
  isActive: Boolean
  name: String
  type: AppTypeEnum
  tokens: [AppToken!]
  webhooks: [Webhook!]
  aboutApp: String
  dataPrivacy: String @deprecated(reason: "Use `dataPrivacyUrl` instead.")
  dataPrivacyUrl: String
  homepageUrl: String
  supportUrl: String
  configurationUrl: String @deprecated(reason: "Use `appUrl` instead.")
  appUrl: String
  manifestUrl: String
  version: String
  accessToken: String
  author: String
  deprecationReason: String
  extensions: [AppExtension!]!
  problems(limit: PositiveInt): [AppProblem!]
  brand: AppBrand
  breakerState: CircuitBreakerStateEnum!
  breakerLastStateChange: DateTime
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

The ID of the app.

privateMetadata

privateMetadata · [MetadataItem!]!

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

privateMetafield

privateMetafield · String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

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.

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

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

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

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

keys

keys · [String!]

identifier

identifier · String

Canonical app ID from the manifest

Added in Saleor 3.19

permissions

permissions · [Permission!]

List of the app’s permissions.

created

created · DateTime

The date and time when the app was created.

isActive

isActive · Boolean

Determine if app will be set active or not.

name

name · String

Name of the app.

type

type · AppTypeEnum

Type of the app.

tokens

tokens · [AppToken!]

Last 4 characters of the tokens.

Requires one of the following permissions:MANAGE_APPSOWNER

webhooks

webhooks · [Webhook!]

List of webhooks assigned to this app.

Requires one of the following permissions:MANAGE_APPSOWNER

aboutApp

aboutApp · String

Description of this app.

dataPrivacy

dataPrivacy · String

Description of the data privacy defined for this app.

dataPrivacyUrl

dataPrivacyUrl · String

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

homepageUrl

homepageUrl · String

Homepage of the app.

supportUrl

supportUrl · String

Support page for the app.

configurationUrl

configurationUrl · String

URL to iframe with the configuration for the app.

appUrl

appUrl · String

URL to iframe with the app.

manifestUrl

manifestUrl · String

URL to manifest used during app’s installation.

version

version · String

Version number of the app.

accessToken

accessToken · String

JWT token used to authenticate by third-party app.

author

author · String

The App’s author name.

deprecationReason

deprecationReason · String

Reason why the app is deprecated, set by the app itself. Null when the app is not deprecated. A deprecated app keeps working as usual, but usually means it should not be used anymore.

Added in Saleor 3.23