teamspace comes with a REST API that lets you read data out of your installation and create new data – from your own scripts, from third-party systems or from devices such as a time-clocking terminal. Instead of clicking through the interface, you talk to teamspace directly over HTTP requests.
The API follows the same principles throughout: every resource has an address (URL), requests use the usual HTTP methods (GET to read, POST to create, PUT to change), and authentication runs via a device password (API token) using Basic Auth.
The standards the API builds on
The API builds on established web standards – if you know them, you will find your way around quickly:
- REST – resources are addressed via URLs, actions are expressed via HTTP methods.
- HATEOAS – responses contain links (
href) to related resources. Instead of assembling IDs yourself, you follow the links the API provides. - JSON – requests and responses are JSON objects.
- Basic Auth – every request authenticates via HTTP Basic Authentication (device ID and token).
Work in progress: The API is continually being extended. At present the areas that are best supported are time tracking (project list, booking times, check-in/out), CRM (contacts and organisations) and costs/expenses. Further resources are added with new teamspace versions.
What the API is good for
- Custom integrations: keep data in sync between teamspace and a third-party system (for example, a web shop that creates contacts or documents).
- Automation: handle recurring bulk operations via a script instead of clicking through them one by one.
- Devices & terminals: a time-clocking terminal checks employees in and out – via its own, neutral access authorisation.
- Reporting: read data out at regular intervals and feed it into your own reports or dashboards.
What you need to get started
- A teamspace installation with its server address (for example
https://app1.teamspace.de). - API credentials – a device password (API token) or an API access authorisation. How to sign in is covered in Create and use a device password (API token).
- A basic understanding of REST/HTTP – which URL addresses which resource is explained in API address structure.
A guide through the topic
- Understand addresses: API address structure (URLs) – how collection, element ID, matrix parameters and query combine into a URL.
- Sign in: Create and use a device password (API token) – create a device password and use it via Basic Auth.
- Devices & services: API access authorisation for terminals & services – neutral authorisation without a personal user.
- Practise: Create a contact via the API – a complete use case, step by step.
- Documents: Create expenses & documents via the API and the Field reference: expense & document fields.
- Run it safely: API security & permissions.
Tools to experiment with
- API explorer: a built-in browser app that lets you browse the API and see how resources and relationships are structured. You reach it at
<server>/htdocs/apps/apiexplorer/index.html(public example:https://sync.projectfacts.de/htdocs/apps/apiexplorer/index.html). - Data model as TypeScript: the JSON representations are available as TypeScript classes at
<server>/api/api/dto.ts– handy for looking up fields and types. - Browser developer tools: use them to follow the real communication between app and API.
The full reference – the API Compact Guide: The detailed end-to-end guide with concrete request and response examples is the API Compact Guide – as PDF, PowerPoint and online. All downloads are on the API Compact Guide page. This help centre explains the concepts and the most important workflows; for complete payloads, the Compact Guide is the authoritative source.