Planhat

How to set up a Service Account and retrieve an API Access Token

To quickly set up a Service Account, refer to the GIF below. Click to view it in a larger format. For detailed step-by-step instructions, see the text following the GIF.

1. Hover over your avatar (initial or photo) in the bottom right corner of your Planhat tenant, and click "Service Accounts."

   📌 Note: If "Service Accounts" is not visible, your user account may not have access. Contact a Planhat admin to adjust your role settings if necessary.

   • 

2. Click the blue "Add New" button

3. A modal will appear: ​

   

   • Name - give your Service Account a suitable name

   • Copy Permissions From

     • Here you define which permissions the Service Account has (so what its associated API Access Token will be able to do). Note that you can change this later if required

     • You have the option to:

       • Start from scratch

       • Use the permissions of your choice of existing Service Account

       • Use the permissions of your choice of existing Role

     • This is great because you don't need to start from scratch each time you want to define permissions!

     • If you would like to know more about our permissions then check out this article 👍 ​

4. Your Service Account has now been created! It will open up a modal similar to this:

   

   • INFO - in this tab, you can add a description to explain what the Service Account is used for, and generate API Access Tokens (as described in the next step)

   • PERMISSIONS - here you can set/edit the Service Account permissions (what the API Access Token can be used for)

   • LOGS - view your API request history

5. Click the blue "Generate New Token" button at the bottom of the "INFO" tab to generate your API Access Token

   • 📌 Important to note: The API Token will only be displayed this once, so make sure you copy it and store it securely. If you lose it and need it again, you will need to generate a new API Token

6. Copy the API token

7. You can now close the modal

8. Go to churned > integrations > paste the API token into the Churned integration form.

Click Save to test the connection. Once it’s working, notify the Churned team to begin syncing data.