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

# API GraphQL

Introduction générale

L'API (**A**pplication **P**rogramming Interface) permet d'interconnecter **demarche.numerique.gouv.fr** à d'autres systèmes d'information ou d'autres logiciels.

Aujourd'hui notre API est **sortante et entrante.** Vous pouvez donc aussi bien **lire que écrire des données dans demarche.numerique.gouv.fr**.

### Quelques exemples de données que vous pouvez récupérer depuis **demarche.numerique.gouv.fr** :

* les informations d'une démarche,
* la liste des dossiers d'une démarche,
* le détail d'un dossier
* etc.

### Quelques exemples de données que vous pouvez écrire dans **demarche.numerique.gouv.fr** :

* Envoyer un message à l'usager d'un dossier ;
* Changer l'état d'un dossier (accepté, refusé, etc.)
* etc.

### Exemples de cas d'usage de l'API :

* construire des tableaux de bord afin de piloter le déploiement d'une démarche
* utiliser **demarche.numerique.gouv.fr** pour ses formulaires et verser les dossiers saisis par les usagers dans votre Système d'Information afin de les instruire vous-même.
* construire une interface sur mesure pour instruire les dossiers dans votre application

### Comment accéder à l'API ?

Si vous n'avez pas un profil technique, **nous vous invitons à contacter une personne de votre service informatique qui sera à même de réaliser l'intégration de l'API en fonction de vos besoins.**


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.demarches-simplifiees.fr/api-graphql.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.