⌘K
Open app

API keys

Creating a key, copying it once, turning it off, deleting it.

Overview

An API key is how your systems prove who they are when they talk to Mira. You make keys in Settings, under API Access. Owners and admins see that page.

A key acts as you, in one organisation. It can reach what you can reach in the app, and nothing more. If you belong to more than one organisation, make a key in each one you need.

You can have up to two keys in each organisation. Two lets you swap a key without a gap: make the new one, move your systems over, then delete the old one.

Creating a key

  1. Open Settings and choose API Access.
  2. Click Create new key, then Create to confirm.
  3. Your new key appears. Click Copy key and store it somewhere safe, such as your password manager or your system's secret store.
  4. Tick I've saved this key somewhere safe, then click Done.

If you already have two keys, Create new key is greyed out. Delete one first.

Turning a key off

Each key has a switch beside it, and a label that reads Active or Inactive. Turn the switch off and every request using that key is refused straight away, with a 401. Turn it back on and the key works again.

Use this to pause an integration, or to check whether anything still uses a key before you delete it.

Deleting a key

Click the bin icon beside a key, then Delete to confirm. Anything still using the key stops working, and this can't be undone. If you need a key again, create a new one and give it to your systems.

Finding your ids

Below your keys, Your IDs gives you what your requests need.

  • Project ID. Pick a department and its id appears beside the picker. This is the ProjectID every data request names.
  • Card ID. Pick a department and its tables are listed beneath. Click a table to select it and copy its id. You need it to replace or delete that table.

Click any id to copy it.

The quickstart

On the right of the page is a working example of an upload, in cURL, Python and JavaScript. It fills in the department and table you picked, so it is a quick starting point. Import data explains each part, and has the full examples.