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

# API-Dokumentation

Ihr findet die API-Dokumentation für eure Instanz wenn ihr angemeldet seid rechts oben (bei deinem Avatar) im Einstellungs-Menü.

<figure><img src="https://1380976415-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-La4YdZ1Gw5iHapqZfIo%2Fuploads%2F9Ll26x9NHCeprD0WG2Uc%2FBildschirmfoto%202026-06-17%20um%2018.03.22.png?alt=media&amp;token=03112fa6-75a6-48bf-a35d-5e25f11f1d0e" alt=""><figcaption></figcaption></figure>

Wenn du keinen Zugang zu einer Instanz hast, kannst du dir die API-Dokumentation hier ansehen:

```
https://system.dieagenturverwaltung.de/app/docs/api
```

Die API für dein System ist unter der Mandanten-URL deines Systems erreichbar z.B.:

```
https://<meinefirma>.dieagenturverwaltung.de

Dokumentation:
https://<meinefirma>.dieagenturverwaltung.de/app/docs/api

Beispiel für die Login-Route:
https://<meinefirma>.dieagenturverwaltung.de/api/v2/auth/login
```

### API Keys erzeugen

Hier wir erklärt, wie du dir einen API-Token erzeugen kannst.&#x20;

{% content-ref url="/pages/1IFPqcsjjpNZLibOhNAy" %}
[API-Tokens](https://wiki.dieagenturverwaltung.de/einstellungen-1/integrationen/api-tokens.md)
{% endcontent-ref %}

Den Token sendest Du mit folgendem Header mit jedem Request mit:

```
{
    "Authorization": "Bearer <API-Token>"
}
```

### API-Glossar

| API-Begriff                   | Bezeichnung in der Agenturverwaltung   |
| ----------------------------- | -------------------------------------- |
| Absence Additional Contingent | Abzüge & Zuschläge zum Urlaubskonto    |
| Absence Contingent            | Urlaubskontingent                      |
| Account                       | Etat                                   |
| Accounting                    | Buchhaltungsexport                     |
| Accounting Contact            | Personenkonten (Debitoren/Kreditoren)  |
| Added Value                   | Wertschöpfung an KV-Positionen         |
| Asset Account                 | Sachkonto-Vorschläge                   |
| Attachment                    | Datei-Anhang                           |
| Attendance                    | Anwesenheit                            |
| Auth                          | Login, Passwort vergessen, Logout      |
| Bank Account                  | Bankverbindung an Adresskontakten      |
| Catalog                       | Produkt- und Leistungskatalog          |
| Commission                    | Provisionen                            |
| Contact                       | Adressbuch-Kontakte                    |
| Craft                         | Funktionen                             |
| Credit Invoice                | Gutschriften                           |
| Creditor                      | Offene Posten Kreditoren               |
| Custom Filter                 | Benutzerdefinierte Filter              |
| Custom Report                 | Benutzerdefinierte Berichte            |
| Customer                      | Kunden                                 |
| CustomField                   | Benutzerdefinierte Felder              |
| Dashboard                     | Dashboard                              |
| Debitor                       | Offene Posten Debitoren                |
| Email                         | E-Mail                                 |
| Employment Contract           | Arbeitsverhältnis                      |
| Estimate                      | Kostenvoranschläge                     |
| Finance                       | Finanzdokumente allgemein              |
| Finance Journal               | Finanzdokumente allgemein              |
| Finance Journal Positions     | Finanzdokumentpositionen               |
| FinDocCategory                | Kosten- und Erlöskategorien            |
| Forecast                      | Vorschaubericht                        |
| General                       | Allgemein                              |
| General Info                  | Unternehmensdaten                      |
| Holiday                       | Feiertage                              |
| Integrations                  | Integrationen                          |
| Invoice                       | Ausgangsrechnungen                     |
| Job                           | Projekte                               |
| Job Tasks                     | Projekt-Zeiten                         |
| Me                            | Infos zum angemeldeten Benutzer        |
| Metrics                       | Kennzahlen                             |
| Office Location               | Standorte                              |
| Order Confirmation            | Auftragsbestätigungen                  |
| Organisation                  | Adressbuch-Kontakte von Organisationen |
| Payment                       | Zahlungen                              |
| Person                        | Adressbuch-Kontakte von Personen       |
| Procedure                     | Aufgaben                               |
| Procedure View                | Aufgabenansichten                      |
| Purchase Invoice              | Eingangsrechnungen                     |
| Purchase Order                | Lieferantenaufträge                    |
| Resource Planning             | Kapazitätsplanung                      |
| Snippet                       | Textbausteine                          |
| Target                        | Ziele                                  |
| Team                          | Teams                                  |
| Template                      | Vorlagen                               |
| User                          | Benutzer                               |
| User Craft                    | Funktionen (der Zeiterfassung)         |
| User Group                    | Benutzergruppen                        |
| User Group Actions            | Berechtigungen in Benutzergruppen      |
| User Group Users              | Benutzer in Benutzergruppen            |
| WorkPattern                   | Tätigkeiten der Zeiterfassung          |


---

# 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://wiki.dieagenturverwaltung.de/api-dokumentation.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.
