> 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 don't 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 we explain how you can create an API token.&#x20;

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

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

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

### API glossary

| API term                      | Name in Die Agenturverwaltung                    |
| ----------------------------- | ------------------------------------------------ |
| Absence Additional Contingent | Deductions & surcharges for the vacation account |
| Absence Contingent            | Vacation 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 in address book contacts            |
| Catalog                       | Product and service catalog                      |
| Commission                    | Commissions                                      |
| Contact                       | Address book contacts                            |
| Craft                         | Functions                                        |
| Credit Invoice                | Credit invoices                                  |
| Creditor                      | Outstanding creditor items                       |
| Custom Filter                 | Custom filters                                   |
| Custom Report                 | Custom reports                                   |
| Customer                      | Customers                                        |
| CustomField                   | Custom fields                                    |
| Dashboard                     | Dashboard                                        |
| Debtor                        | Outstanding debtor items                         |
| Email                         | E-mail                                           |
| Employment Contract           | Employment relationship                          |
| Estimate                      | Estimates                                        |
| Finance                       | General finance documents                        |
| Finance Journal               | General finance documents                        |
| Finance Journal Positions     | Finance document items                           |
| FinDocCategory                | Cost and revenue categories                      |
| Forecast                      | Forecast 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                              |
| Organization                  | Address book contacts of organizations           |
| Payment                       | Payments                                         |
| Person                        | Address book contacts of persons                 |
| Procedure                     | Tasks                                            |
| Task View                     | Task views                                       |
| Purchase Invoice              | Purchase invoices                                |
| Purchase Order                | Supplier orders                                  |
| Resource Planning             | Capacity planning                                |
| Snippet                       | Text snippets                                    |
| Target                        | Goals                                            |
| Team                          | Teams                                            |
| Template                      | Templates                                        |
| User                          | Users                                            |
| User Craft                    | Time tracking functions                          |
| 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 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://wiki.dieagenturverwaltung.de/die-agenturverwaltung-en/api-documentation.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.