Trella Health User API

Overview

The User API allows Trella Health customers to automate the creation, update, deletion of users in the Trella Health platform thereby avoiding the need to manually perform these actions within the Trella Health Admin tool. The User Service also allows the assignment of permissions (roles) to individual users.

Note: This API is currently only available for Marketscape Insights and Strategy customers. Marketscape CRM will be supported in Fall 2023.

Usage Steps

  • Obtain an API key and a system account. The system account is tied to a valid email in your email domain (e.g. trella.api@<yourdomain.com>). To request an API key and system account, please send an email to apisupport@trellahealth.com with a valid email address for the system account.


 

  • Once you receive confirmation of your API key and creation of your system account, you will need to setup a password for your system account. To do so, navigate to https://app.trellahealth.com and initiate the password reset flow for the email address you provided above for the system account.

  • The API is hosted at https://userapi.trellahealth.com. The API key needs to be set in the HTTP request header for all API calls as follows:

x-api-key=[your-secret-key]
  • Use the /User/login API endpoint to obtain a JWT token. Add the JWT token to the HTTP request header for all subsequent API calls as follows:

Authorization: Bearer [your-jwt-token]

Swagger Documentation