Documentation can be found here:

You can see the full list of endpoints, attributes, etc. by referring to our public API docs here: https://api.services.thrivetrm.com/api/docs/v2/

Please note, if you do not see the data you need in the json payload examples there is an “include” section that contains a list of additional properties available. You will need to test using the documentation and token or Postman to get a full list of responses.

​

At this time there are rate limits in place to protect the system.

Please contact your CS representative for more information.

​

You can test directly in the documentation or you can use Postman.

Login to Thrive TRM as an Admin.

Click the “My Account” profile image in the upper right hand corner

Select “Integrations” from the drop down menu

On the Integrations page, select “API Keys”

Click “Generate new token”

Copy the API key and keep it in a safe place. You’ll need to use it every time you make a request using the API.
​

Your token will continue to work.
​

You should use https://api.services.thrivetrm.com/api/v2 and your token will handle routing to the correct data source.
​

You can test within a sandbox environment and there would be a cost associated to stand this up. Please contact your CS representative for more details.
​

Our API is served over the HTTPS protocol with RESTful endpoints. API requests accept JSON and return JSON.
​

You will need to move from the https://api.services.thrivetrm.com/api/v2 endpoint by 06/30/2023
​

The authorization type is now API Key with the Key of “x-api-key” and value is your token. You can view an example using the Thrive Postman setup here.