Creating a Brim API Token

When to Use an API Token

Use an organization API token if you plan to:

• Set up a streamlined clinical workflow integration
• Regularly update patient data via API

This token enables secure, programmatic access to your Brim instance via the Brim API.

API Token Scope

There are two types of API tokens available. They are used in the same way in API calls, but the data they access has different scopes.

• Project API Token. This token can be used to access the project for which it was created.
• Organization API Token. This token can be used to access any project in the organization.

We recommend using Project API tokens when possible to limit data access.

How to Create a Project-Level API Token

1. Go to Settings > Manage Project for the project you want to access via API.
2. Scroll to the Project API Tokens section
3. Select a user to own the token
4. Enter an email address to receive token update notifications
   • If left blank, the notifications will go to the token owner's email address
5. Click Create Token.
6. Copy the token text—you’ll need it when making API calls.

How to Create an Organization-Level API Token

1. Go to Settings > Admin
2. Click Org Settings in the top navigation bar
3. Scroll to the Organization API Tokens section
4. Select a user to own the token.
   1. NOTE: For organization-level tokens, only admins are eligible to own a token.
5. Enter an email address to receive token update notifications
   • If left blank, the notifications will go to the token owner's email address
6. Click Create Organization Token
7. Copy the token text—you’ll need it when making API calls.

Managing an Existing Token

• To deactivate a token, click the Deactivate button next to it
• To copy the token again, click the value under the Token column

Need help integrating with the API? Contact Support or refer to our API documentation.