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