API Documentation

Summary

The Bluerithm API allows you to programmatically access data from your Bluerithm account and projects.

Authentication

The Bluerithm API uses API keys to authenticate requests. You can view and manage your API keys in My Company > Admin > API Keys page.

API requests also need to include your Tenant ID in the header (a key called x-tenant-id with your tenant ID as the value). You can find your tenant ID on My Company > Admin > API Keys page in the web app. Your API keys carry many privileges and must be stored securely. Do not share your secret API keys.

Authentication to the API is performed via API Key authentication. Provide your API key x-api-key value when making calls to the API.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Miscellaneous

Any “ID” referred to for query parameters will always be a unique ID that matches up to a database record, and not a editable field in Bluerithm. If needed, you can usually find the ID of an item in the url when viewing items in the Bluerithm web app.

Depending on the dataset you want to create with API calls, sometimes you'll need to do recursive API calls to get a complete set. For example, there is no endpoint that returns all issues on a project. But there are endpoints that return issues that are attached to equipment, as well as to the project. Meaning, if you wanted ALL issues on a project, you'd need to make individual calls to get:

the project
each folder on the project
the equipment in each folder
the issues on each equipment
and finally the issues attached to the project itself.

Endpoint definitions

You can fine definitions for all endpoints here: https://b2b.bluerithm.com/index.html

Development and Testing

We recommend a tool like Postman for testing your authentication and calls to the API.