v50

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-09181183330.0 KB
graphql

Run a query or mutation

Run a query or mutation as a system user that bypasses authentication and data access rules. You can access metadata about your API, including its schema, with an introspection query.

post/groups/{groupId}/apps/{appId}/graphql

Request body

querystring required

A stringified .graphql file that contains one or more valid GraphQL operations for your API. If more than one operation is defined, you must specify which operation to run in operationName.

variablesstring

A stringified JSON object where each field name maps a value to a variable in the specified operation.

operationNamestring

The name of the GraphQL operation specified in query to run.

Example request

{
  "query": "query AllTasks { tasks(query: { status: $status }) { _id owner } }",
  "variables": "{ \"status\": \"complete\" }",
  "operationName": "AllTasks"
}

Response

OK

dataobject nullable required

The result of a successful operation. If null, the operation had errors.