> For the complete documentation index, see [llms.txt](https://docs.iadvize.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iadvize.dev/technologies/graphql-api/reference.md).

# Reference

## Schema Documentation

Our schema documentation lists all the content of our GraphQL API's schema. So you'll find all the queries and mutation that are available, as well as a description of the types manipulated by the API.

Do note that Apollo offers the same capabilities, but where Apollo requires to be authenticated with a valid iAdvize account, the static documentation is available and shareable publicly.

<table data-card-size="large" data-view="cards" data-full-width="false"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Read our Schema Documentation</strong></td><td><a href="https://graphql.iadvize.dev/">https://graphql.iadvize.dev/</a></td></tr></tbody></table>

## Apollo

You can discover the schema and run queries on your iAdvize data using Apollo, an integrated development environment in your browser that includes the schema description, syntax highlighting, and validation errors.

<table data-card-size="large" data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Experiment with our GraphQL API</strong></td><td><a href="https://ha.iadvize.com/apollo">https://ha.iadvize.com/apollo</a></td></tr></tbody></table>

### Using Apollo <a href="#using-apollo" id="using-apollo"></a>

#### Authentication

You'll need to be authenticated in order to test queries. If you weren't already, you'll automatically be prompted to sign-in when reaching the Apollo page, after which you'll be able to continue using the query editor.

You can test your access by querying your projects:

<pre class="language-graphql"><code class="lang-graphql"><strong>query {
</strong>  projects {
    edges {
      node {
        id
        name
      }
    }
  }
}
</code></pre>

{% hint style="info" %}
[Test this query in our editor](https://ha.iadvize.com/apollo?explorerURLState=N4IgJg9gxgrgtgUwHYBcQC4QEcYIE4CeABMADpJFEAOeEAVglCgM4nmWUJgDmCrZFDpSQQwCNoKGUAlmHZThAQ0TyhAX1VENg7WpBqgA)
{% endhint %}

#### **Using the query variables pane**

If you want to learn more about variables in GraphQL you can read this documentation: <https://graphql.org/learn/queries/#variables>


---

# 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:

```
GET https://docs.iadvize.dev/technologies/graphql-api/reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
