> 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/die-agenturverwaltung-en/api-documentation.md).

# API documentation

You can find the API documentation for your instance when you are logged in at the top right (next to your avatar) in the settings menu.

<figure><img src="https://4063991107-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>

If you do not have access to an instance, you can view the API documentation here:

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

The API for your system can be reached at your system's tenant URL, e.g.:

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

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

Example of the login route:
https://<meinefirma>.dieagenturverwaltung.de/api/v2/auth/login
```

### Generate API keys

Here it is explained how you can generate an API token.&#x20;

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

You send the token with the following header with every request:

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

### API glossary

| API term                      | Label in Die Agenturverwaltung                 |
| ----------------------------- | ---------------------------------------------- |
| Absence Additional Contingent | Deductions & surcharges to the holiday account |
| Absence Contingent            | Holiday quota                                  |
| Account                       | Customer account                               |
| Accounting                    | Accounting export                              |
| Accounting Contact            | Personal accounts (debtors/creditors)          |
| Added Value                   | Value added to estimate items                  |
| Asset Account                 | General ledger account suggestions             |
| Attachment                    | File attachment                                |
| Attendance                    | Attendance                                     |
| Auth                          | Login, forgot password, logout                 |
| Bank Account                  | Bank details on address contacts               |
| Catalog                       | Product and service catalog                    |
| Commission                    | Commissions                                    |
| Contact                       | Address book contacts                          |
| Craft                         | Functions                                      |
| Credit Invoice                | Credit invoices                                |
| Creditor                      | Open items creditors                           |
| Custom Filter                 | Custom filters                                 |
| Custom Report                 | Custom reports                                 |
| Customer                      | Customers                                      |
| CustomField                   | Custom fields                                  |
| Dashboard                     | Dashboard                                      |
| Debtor                        | Open items debtors                             |
| Email                         | Email                                          |
| Employment Contract           | Employment relationship                        |
| Estimate                      | Estimates                                      |
| Finance                       | General finance documents                      |
| Finance Journal               | General finance documents                      |
| Finance journal entries       | Finance document entries                       |
| FinDocCategory                | Cost and revenue categories                    |
| Forecast                      | Preview report                                 |
| General                       | General                                        |
| General Info                  | Company data                                   |
| Holiday                       | Holidays                                       |
| Integrations                  | Integrations                                   |
| Invoice                       | Invoices                                       |
| Job                           | Jobs                                           |
| Job Tasks                     | Job times                                      |
| Me                            | Info about the logged-in user                  |
| Metrics                       | Metrics                                        |
| Office Location               | Locations                                      |
| Order Confirmation            | Order confirmations                            |
| Organisation                  | Address book contacts of organizations         |
| Payment                       | Payments                                       |
| Person                        | Address book contacts of persons               |
| Procedure                     | Tasks                                          |
| Procedure View                | Task views                                     |
| Purchase Invoice              | Purchase invoices                              |
| Purchase Order                | Supplier orders                                |
| Resource Planning             | Capacity planning                              |
| Snippet                       | Text snippets                                  |
| Target                        | Targets                                        |
| Team                          | Teams                                          |
| Template                      | Templates                                      |
| User                          | User                                           |
| User Craft                    | Functions (of time tracking)                   |
| User Group                    | User groups                                    |
| User Group Actions            | Permissions in user groups                     |
| User Group Users              | Users in user groups                           |
| WorkPattern                   | Time tracking activities                       |


---

# 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/die-agenturverwaltung-en/api-documentation.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.
