> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/canvas/resources/graph_ql.md).

# GraphQL

Canvas exposes a GraphQL API at `/api/graphql`. Unlike the REST API, GraphQL has a single endpoint, so granting the GraphQL scope to an access token allows it to issue any query or mutation the authenticated user is otherwise permitted to perform.

See the [GraphQL documentation](/services/canvas/basics/file.graphql.md) for details on the schema and how to build queries.

## [Execute a GraphQL query](#method.graphql.execute) <a href="#method.graphql.execute" id="method.graphql.execute"></a>

[GraphqlController#execute](https://github.com/instructure/canvas-lms/blob/master/app/controllers/graphql_controller.rb)

#### `POST /api/graphql`

**Scope:** `url:POST|/api/graphql`

Execute a GraphQL query or mutation against the Canvas GraphQL schema.

#### Request Parameters:

| Parameter       | Type     | Description                                                                                         |
| --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| `query`         | `string` | The GraphQL query or mutation to execute.                                                           |
| `operationName` | `string` | <p>The name of the operation to run when the query document defines more<br>than one operation.</p> |
| `variables`     | `Hash`   | Values for any variables referenced by the query.                                                   |

***

This documentation is generated directly from the Canvas LMS source code, available [on Github](https://github.com/instructure/canvas-lms).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developerdocs.instructure.com/services/canvas/resources/graph_ql.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.