Skip to main content
All CollectionsIntegrations
Thrive API FAQ
Thrive API FAQ

Common questions about Thrive's API

Kelsey Chan avatar
Written by Kelsey Chan
Updated over a week ago

  1. Where do I find documentation on the Public API?

    1. Documentation can be found here:

      1. https://api.services.thrivetrm.com/api/docs/v2/
        ​

  2. Which data is available?

    1. 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/

    2. 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.


      ​

  3. Are there any limits on number of API calls?

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

      1. The rate limit is 100 requests per second.


        ​

  4. How much does API access cost?

    1. Please contact your CS representative for more information.


      ​

  5. How can we access endpoints to do testing via something like Postman?

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

      1. Walkthrough of Thrive Postman setup.
        ​

  6. How do I generate tokens?

    1. Login to Thrive TRM as an Admin.

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

    3. Select “Integrations” from the drop down menu

    4. On the Integrations page, select “API Keys”

    5. Click “Generate new token”

    6. 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.
      ​

  7. What happens to my token if the admin user that generated is no longer an admin?

    1. Your token will continue to work.
      ​

  8. What url should I use for each tenant?

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

  9. Are there lower environments that we can use for development?

    1. 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.
      ​

  10. What protocol does your API use?

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

  11. When do I have to move to the new https://api.services.thrivetrm.com/api/v2 endpoint?

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

  12. What type of authentication changes do I need to make, if any, with the new endpoint?

    1. 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.

Did this answer your question?