The Nomio API allows you to connect Nomio with other systems.

With the Nomio API, you can:


📖 Reference

The API Reference is here: **https://app.nomio.com/api/v1/docs**

The API Reference lists all of our API endpoints, together with the expected inputs and outputs for each.


🚦 Getting Started

You’ll need an API key in order to use the Nomio API.

<aside> <img src="/icons/report_gray.svg" alt="/icons/report_gray.svg" width="40px" />

Only Administrators can create API keys. If you’re not one, get in touch.

</aside>

  1. Go to **https://region.nomio.com/org/manage-api** where…

    You can find both by logging into Nomio and looking at the URL (e.g. https://app.nomio.com/infinity/agreements).

  2. Click Generate New Credentials.

    <aside> <img src="/icons/report_gray.svg" alt="/icons/report_gray.svg" width="40px" />

    Your key can only be copied in full when you create the key, so make sure you copy it and store it securely.

    </aside>

    image.png

  3. Test your API key works using our interactive API reference page:

    1. Click Authorize in the top-right of the page and enter your API key.

    2. Open GET /api/v1/status and click Try It Out, then Execute.

      This will send a real request to our API: if your API key is valid, you should see {"status": "ok"}.