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

# Admin API

The Admin API allows your server to manage users via a GraphQL endpoint. You can list users, search users, view user details, and many more. In fact, the user management part of the portal is built with the Admin API.

## The Admin API GraphQL endpoint

The Admin API GraphQL endpoint is at `/_api/admin/graphql`. For example, if your app is `myapp` , then the endpoint is `https://myapp.authgear.cloud/_api/admin/graphql` .

## Authentication of the API endpoint

Accessing the Admin API GraphQL endpoint requires your server to generate a valid JWT and include it as `Authorization` HTTP header.

See [Authentication and Security](/reference/apis/admin-api/authentication-and-security.md) to learn how to access the Admin API securely.

## API Explorer

If you want to explore what the Admin API can do, you can visit the GraphiQL tool. The GraphQL schema can also be found there.

* Go to **Advanced** -> **Admin API**
* Click on the **GraphiQL tool** link
* Toggle the **schema** documentation by pressing the Docs button in the top left corner.

<figure><img src="/files/5uADv9Li8XIt4JPHSQHt" alt=""><figcaption><p>Explor the Admin API with GraphiQL tool from the Admin Portal</p></figcaption></figure>

{% hint style="danger" %}
The GraphiQL tool is NOT a sandbox environment and all changes will be made on **real, live, production data**. Use with care!
{% endhint %}

## API Schema

{% content-ref url="/pages/1rc0ms4aPMzzq8ri6zlD" %}
[API Schema](/reference/apis/admin-api/api-schema.md)
{% endcontent-ref %}

## API Examples

{% content-ref url="/pages/k9OsUIA7hmhGI2gB4Ilq" %}
[API Queries and Mutations](/reference/apis/admin-api/api-queries-and-mutations.md)
{% endcontent-ref %}


---

# 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://docs.authgear.com/reference/apis/admin-api.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.