Setting up API

Set up Touchplan's API for your organization

Sarah Cusack avatar
Written by Sarah Cusack
Updated over a week ago

Touchplan's API is a RESTful API that will allow your organization to access your Touchplan project's data and information. Once the API is enabled you will be able to connect to and pull Touchplan data into other applications.

To learn more about accessing Touchplan's API for your organization contact your project's Customer Success Manager or write into the Live Chat under the Support tab.

Once you have the permission level needed to manage access to the API

How access the API Settings in Touchplan

  1. Click on your name in the upper right-hand corner

  2. Select API Settings

  3. Click + Application

  4. Fill in the Application Name, Application Description, and Main Website Address

  5. Toggle over to projects to ensure the correct ones are selected

  6. Click Save

  7. Now you can view the clientId and clientSecret for this Application

Note: The secret is only visible once - if you need to view it again you will need to generate a new secret

Access the API documentation by clicking here.

Did this answer your question?