Tutorials

Call the API

Call the Miridia APIRecording coming soon

Miridia has two APIs:

The Global API, at https://global.miridia.io, handles accounts, login, and API keys.
The core API, at https://api.miridia.io, holds your business data: products, orders, stock, and more.

In this tutorial you log in, create an API key, and use the key to list your products.

What you need

A Miridia user that is an owner of the organisation. Only an owner can create an API key.
The identifier of your business. You can find it in the business settings of the portal.
curl in a terminal. The examples use Bash. In PowerShell, use curl.exe.

Steps

Log in

Send your email address and your password to the Global API.

Terminal

curl -s https://global.miridia.io/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{ "email": "you@example.com", "password": "<your-password>" }'

If your user belongs to one organisation, the response contains a session with an access token:

Response

{
  "data": {
    "requiresOrganizationSelection": false,
    "session": {
      "accessToken": "<access-token>",
      "expiresAtUtc": "2026-09-29T14:00:00Z",
      "organization": { "id": "<organization-id>", "slug": "example-foods", "name": "Example Foods" }
    }
  },
  "statusCode": 200,
  "messages": []
}

Select an organisation, if necessary

If your user belongs to more than one organisation, the response has requiresOrganizationSelection: true, a short-lived selectionToken, and a list of organizations. Send the selection token as a bearer token, with the organisation that you want:

Terminal

curl -s https://global.miridia.io/api/auth/select-organization \
  -H "Authorization: Bearer <selection-token>" \
  -H "Content-Type: application/json" \
  -d '{ "organizationId": "<organization-id>" }'

The response contains the session with the access token.

Create an API key

An access token expires after a short time. For a script or an integration, create an API key. Send the access token and the business that the key acts for:

Terminal

curl -s https://global.miridia.io/api/auth/tokens \
  -H "Authorization: Bearer <access-token>" \
  -H "Content-Type: application/json" \
  -d '{ "label": "Stock report script", "businessId": "<business-id>", "ttlMinutes": 525600 }'

The token field of the response is the API key. Copy it now and keep it in a secret store.

The request has these fields:

businessId

string required

The business that the key acts for.

label

string

A name that helps you find the key later.

ttlMinutes

number

The life of the key, in minutes. 525600 minutes is one year.

scopes

string

Optional. A permission grant that limits what the key can do. If you omit it, the key has no limit.

An API key gives access to the data of your business. Do not put it in source control, in a browser, or in a mobile app. Delete a key that you no longer use with DELETE /api/auth/tokens/{id}.

List your products

Send the API key in the x-dispatch-api-key header to the core API:

Terminal

curl -s "https://api.miridia.io/api/v1/Products?Page=1&PageSize=20" \
  -H "x-dispatch-api-key: <api-key>"

The response is a page of products:

Response

{
  "data": [ { "id": "<product-id>", "title": "Vanilla ice cream, 500 ml", "sku": "VAN-500" } ],
  "count": 1,
  "totalCount": 1,
  "page": 1,
  "pageSize": 20,
  "hasMore": false
}

Use the access token instead

You can also call the core API with the access token from the login. Then you must send the business in the X-Business-Id header, because a user can belong to more than one business:

Terminal

curl -s "https://api.miridia.io/api/v1/Products?Page=1&PageSize=20" \
  -H "Authorization: Bearer <access-token>" \
  -H "X-Business-Id: <business-id>"

If the header is missing, or the user cannot access the business, the API returns 401.

Next steps

Automate with n8n

Connect n8n to Miridia and send a Telegram or email message each time an order is cancelled.

API overview

The two Miridia APIs, their hosts, and how a request finds your organisation and your business.