BioT REST API

The BioT API is a RESTful API that allows you to access and manage your BioT account and data. The API uses predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Please take a moment to read the getting started article before moving on to other topics under this section.

To make things easier for you, BioT also exports a complete collection of all its APIs in OpenAPI format.
To learn more about generating an SDK suited to your needs please check out this article.

API Optional Parameters

Certain API requests require specific parameters based on whether their containing parent parameter is included. These mandatory parameters are marked with an asterisk.

For instance, in the in the "Create a new Patient" API the "_address" parameter for the patient is optional. Here's an example of a valid API request body:

{
    "_name": {
        "firstName": "John",
        "lastName": "Smith"
    },
    "_ownerOrganization": {
      "id": "0e9711c3-077c-45e5-b60f-eff9de203be9"
    },
    "_email": "js@example-email.com"
}

However, if you include the "_mfa" JSON object, the "_mfa.enabled" attribute becomes mandatory:

{
    "_name": {
        "firstName": "John",
        "lastName": "Smith"
    },
    "_ownerOrganization": {
      "id": "0e9711c3-077c-45e5-b60f-eff9de203be9"
    },
    "_email": "js@example-email.com",
    "_mfa": { 
      "enabled": True 
    }
}