Skip to main content
Frank
Frank
Product Guru
October 25, 2017

API Documentation & How To Get API Credentials

  • October 25, 2017
  • 15 replies
  • 5620 views

Last update 26 May 2021

 

API credentials

You’re now able to ‘self-service’ your own API application integrations by creating and revoking API credentials yourself in Control. View the API page in Control → Integrations → API

Documentation

You can find our API documentation here:

If you’re not sure which of these regions applies to you, please check the API access information section in Control. You can also discover your Base URL here.

Create API client credentials and check your Base URL via the API page (Control > Integrations > API).

Webhooks

Please consult the Webhooks documentation to see a list of what is currently possible: Link

FAQ

Tokens are valid for 2 hours, but if a new token is generated within that time, does it revoke the old one?

No, old tokens are not revoked when a new token is generated. There is no restriction on a number of tokens used simultaneously.

 

    15 replies

    Show previous replies
    revote
    revote
    VIP ⭐️⭐️⭐️⭐️⭐️
    March 31, 2022

    I havent ever use any API´s, I dont know what to do and how to do. Sorry but these instructions doesnt help me at all.

    Is the any n00b instructions, step-by-step guides how to start using API, for example to load user data from the community?

      Yoeri
      Yoeri
      Gainsight Employee ⭐️⭐️⭐️
      April 1, 2022

      Hi Terore, these instructions allow you to get API credentials from the inSided system. You will need to use an external system to work with the API to retrieve user data. I can recommend these youtube series from Postman to learn more about APIs

       

      Group Product Manager, Customer Communities
        revote
        revote
        VIP ⭐️⭐️⭐️⭐️⭐️
        April 4, 2022

        Hi Terore, these instructions allow you to get API credentials from the inSided system. You will need to use an external system to work with the API to retrieve user data. I can recommend these youtube series from Postman to learn more about APIs

         

        Thanks @Yoeri , found them helpful.

          ryanne.perry
          ryanne.perry
          Helper ⭐️
          July 15, 2024

          Are they any API calls or webhook flows that would help to automatically assign a new member a custom role? 

          I know this is possible through Zapier flows (it’s what we currently do) but our company is moving away from Zapier to Tray.io. I did not see any events that showed a ‘custom role’ assignment path.

          🌻 Ryanne
          Kenneth R
          Kenneth R
          Expert ⭐️⭐️
          July 17, 2024

          Hey @ryanne.perry - there is this endpoint that you should be able to use in Tray.io to add custom roles in a similar way as you’ve been doing with Zapier so far.

          Terms & ConditionsAccessibility statement