Use the Miradi API to connect Miradi Share to your other systems: databases, reporting tools, dashboards, and monitoring or data-collection platforms. AI agents also use the API. For agents, see Use Miradi Share with AI Agents (Beta).
Two versions
- API v2 (beta). Reads and writes programs, projects, strategies, indicators, measurements and more. If you are building new connections to Miradi, this is the version to use. It is currently available to beta testers only, with a full release planned for late 2026.
- API v1. Read-only. Power BI and older integrations use it. It continues to work if you do not wish to update your API connections.
Both versions use your Miradi Share permissions. You see and edit only the programs and projects your account can see and edit.
Documentation
Sign in to Miradi Share to access the documentation:
Get access
API access is not automatically available to all Miradi users at this time. Please contact Miradi Support, and:
- Tell us which version you need (v2, v1 or both) and what you want to connect.
- For v1, you must be a Program Admin or Program Manager, and your account needs API permission. We turn on API permission for you.
Sign in
The API uses OAuth 2.0 tokens from the Miradi sign-in service, https://auth.miradishare.org. Send each request with this header:
Authorization: Bearer <token>
Choose the sign-in method that fits your tool:
- Python scripts: the Miradi sign-in library. Download it from the Tools page after you sign in. It gets the token for you, so you do not write the sign-in requests yourself.
- Other scripts and command-line tools: device code. Your script shows a link and a code. You open the link, sign in and approve. The script then gets a token.
- Apps with a browser: authorization code with PKCE. Your app sends you to the Miradi sign-in page. After you sign in, the app gets a token.
The v2 documentation shows the exact requests for each method.
How long a sign-in lasts
| Item | Lasts | What to do when it ends |
|---|---|---|
| Access token | 12 hours | Use your refresh token to get a new access token. |
| Refresh token, not used | 30 days | Each use resets the 30 days. After 30 days without use, sign in again. |
| Refresh token, maximum | 90 days | Sign in again at least every 90 days, even if you use it every day. |
Keep your sign-in working
- When a call that worked before returns 401, your access token has expired. Use your refresh token to get a new one.
- Each refresh token works only once. Every refresh gives you a new refresh token. Keep only the newest one.
- Do not use an old refresh token again. If you do, the sign-in service ends your session everywhere, and you must sign in again.
- For a scheduled job, plan to sign in again at least every 90 days.
Power BI
Use the Miradi Power BI connector to build dashboards from your Miradi data in Microsoft Power BI.
- Sign in to Miradi Share.
- Go to Tools.
- Download the Power BI connector.
- Follow the setup steps in its INSTALL.md file. It covers setup, scheduled refresh in the Power BI Service, and troubleshooting.
Important: The old Keystone sign-in stopped working on 24 October 2026. If your Power BI report or script still uses a Keystone token, it gets an error. Change it to the new sign-in. Contact Miradi Support if you need help.
Questions
Ask questions that other API users can use in the Integrations forum. For all other questions, contact Miradi Support.
Comments
0 comments
Please sign in to leave a comment.