Skip to main content

Getting started

This guide takes you from zero to your first successful request against the Midla Platform API.

1. Activate the API integration on your account​

  1. Log in to your organization's panel (https://your-subdomain.web.midlaplatform.com).
  2. Go to System → Integrations.
  3. Turn on the API integration toggle if it isn't active yet.
  4. Click the gear icon on that row to open its configuration.

2. Generate an access token​

  1. Inside the API integration's configuration, click New token.
  2. Give it a descriptive name (for example, ecommerce-integration).
  3. Select the scopes your integration needs — for example leads:read and leads:create if you're syncing leads. See Authentication for the full list of available scopes.
  4. Optionally, set an expiration date.
  5. Confirm — the token is shown only once. Copy it and store it somewhere safe; you won't be able to see it again (you can always generate a new one if you lose it).
Keep your token secure

The token grants access to your account with whatever permissions you assigned it. Never share it or commit it to a public repository. If you suspect it leaked, revoke it from the same panel and generate a new one.

3. Make your first request​

Every API endpoint lives under:

https://your-subdomain.web.midlaplatform.com/api/platform/v1/{module}/{resource}

For example, to list your CRM leads:

curl https://your-subdomain.web.midlaplatform.com/api/platform/v1/crm/leads \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

If everything is set up correctly, the response is a 200 OK with JSON like this:

{
  "data": [
    {
      "id": 1,
      "name": "Example lead",
      "type": "lead",
      "won_status": "pending",
      "contact": { "name": "Jane Doe", "email": "jane@example.com", "...": "..." },
      "created_at": "2026-09-06T21:38:13+00:00"
    }
  ],
  "meta": { "current_page": 1, "per_page": 15, "total": 1, "last_page": 1 }
}

Next step​

Check out Authentication to understand scopes in detail, or jump straight to the endpoint reference for the module you're interested in.