> 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 (by your avatar) in the settings menu.
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 under the tenant URL of your system, e.g.:
```
https://meinefirma.dieagenturverwaltung.de
Documentation:
https://meinefirma.dieagenturverwaltung.de/app/docs/api
Example for the login route:
https://meinefirma.dieagenturverwaltung.de/api/v2/auth/login
```
To be able to access API routes, you must send an authorization token or a cookie with your request.
You can retrieve these tokens under this route using your login details:
```
/api/v2/auth/login
```
Afterwards, send the sessionToken from the response of this request in the Authorization header.\
Alternatively, you can use the Set-Cookie header to use the cookie `PHPSESSID` for browser-based clients.
### API glossary
| API term | Name 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 on estimate items |
| Asset Account | suggested general ledger accounts |
| 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 items |
| FinDocCategory | cost and revenue categories |
| Forecast | preview report |
| General | General |
| General Info | company data |
| Holiday | public 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 people |
| 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 | users |
| 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 | activities of time tracking |
---
# 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=&goal=
```
`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.