appInstallationSettings

Requires permission settings:apps:install.

An installed app's settings form. Secrets show only a masked hint.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query AppInstallationSettings($installationId: ID!) {
  appInstallationSettings(installationId: $installationId) {
    fields {
      type
      helpText
      key
      label
      placeholder
      required
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppInstallationSettings($installationId: ID!) {\n  appInstallationSettings(installationId: $installationId) {\n    fields {\n      type\n      helpText\n      key\n      label\n      placeholder\n      required\n    }\n  }\n}",
  "variables": {
    "installationId": "id"
  }
}
EOF

Variables:

{
  "installationId": "id"
}

Response:

{
  "data": {
    "appInstallationSettings": {
      "fields": [
        {
          "type": "string",
          "helpText": "string",
          "key": "string",
          "label": "string",
          "placeholder": "string",
          "required": true
        }
      ]
    }
  }
}

appInstallationSettings(
  installationId: ID!
): AppSettingsFormView!

Arguments

appInstallationSettings.installationId ● ID! non-null scalar

The installation whose settings to show.

Type

AppSettingsFormView object

An installed app's settings form: its fields, the saved values and hints of saved secrets.