Run a GraphQL query

v1.0.0

Executes a GraphQL query or mutation against the Salesforce GraphQL API (UI API under the uiapi root field). The request runs against the connected org's My Domain host.

Required scopes: api.

Input

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "The GraphQL document to execute, e.g. `query accounts { uiapi { query { Account { edges { node { Id Name { value } } } } } } }`."
    },
    "variables": {
      "type": "object",
      "description": "Values for variables declared in the document."
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "The query result, mirroring the shape of the request document."
    },
    "errors": {
      "type": "array",
      "description": "GraphQL errors, present when part or all of the request failed.",
      "items": {
        "type": "object"
      }
    }
  }
}