Developers – Introduction
💻 Introduction for Developers
Welcome to Maintella’s developer documentation!
Maintella is designed to integrate with your existing systems and processes. As a developer, you can use our APIs to create, manage, and fetch data for the core entities that power field engineering workflows.
⚠️ Note: Maintella does not currently provide APIs to replace the field engineer user interface with your own application. Field engineers always work via access-key links and the Deftify interface. f replacing the field engineering front-end is important to you, please contact us to discuss your needs.
✨ What You Can Do with the Maintella APIs
The APIs currently cover the admin side of the platform. Common supported use cases include:
✅ Create assets
Programmatically register new equipment or installations.
✅ Create tasks
Assign work to field engineers by creating tasks tied to workflows and assets.
✅ Update workflows
Keep your workflows up to date by programmatically updating steps and actions.
✅ Fetch task data
Retrieve completion information and integrated reports for your tasks.
✅ Integrate with IoT or asset management systems
Sync asset data, diagnostics, or maintenance status with Deftify.
(Covered in detail on a separate integration-focused page.)
Maintella doesn't currently provide callbacks or event based notifications – you may use periodic (eg. every 5 minutes) fetching on index endpoints to check for changes.
🏗️ Core Concepts for Developers
- Assets – Units of equipment you manage. Assets are referenced when creating tasks or retrieving history.
- Workflows – Templates of steps and actions that guide field engineers through work.
- Tasks – Instances of workflows assigned to assets and completed by field engineers.
- Organizations – All API calls are scoped to your organization’s environment.
🔐 Authentication & Access
All API calls are scoped to your organization. Admins authenticate using username/password or an external OAuth2 provider, and you can use API tokens or OAuth2 tokens for server-to-server integrations.
🚀 Next Steps
- Explore our API reference for detailed endpoints and request/response formats.
- Try a simple call: create a test asset or fetch a task’s completion data.
> 💡 Tip: Test your integrations in a non-production environment before rolling out to production.
If you need guidance on a specific integration, check out our dedicated integration guides or contact our support from the widget at the bottom of the screen. Happy building!