Platform API
Welcome to the Platform API documentation for Midla Platform. This section is for technical teams who need to integrate external systems with your organization — syncing leads, shipments, invoicing, or other data — through our REST API.
If you need to learn how to use Midla Platform from the interface (CRM, Operations, Invoicing, etc.), that documentation lives in the Documentation section.
This section is for integrating your own organization. If instead you want one of your customers to check their own shipments/receipts from their own system, that's the Customer API — a different token, with different rules.
What can you do with the API?
The Midla Platform API lets you, among other things:
- Read and create records from your system into Midla (for example, loading leads from your website or an external form).
- Query information from Midla into your system (for example, showing a shipment's status in your own customer's portal).
- Receive notifications when events happen in Midla, via webhooks (coming soon to this documentation).
How this section is organized
| Page | Content |
|---|---|
| Getting started | How to activate the API on your account and make your first request. |
| Authentication | How to generate and use access tokens, and what scopes are. |
| API Reference | Full reference for every endpoint, grouped by module. |
| Errors and response codes | Error format and what each HTTP status code means. |
| Rate Limits | API usage limits and how to handle them. |
| API Changelog | History of API changes. |
Before you start
You need an active Midla Platform account with access to your organization's admin panel. If you don't have an account yet, reach out at midlaplatform.com.