Planhat

📘
Check out the Planhat API Docs for more information.

Set up

Before you can begin using the connector make sure you have the following information available.

Cluster- To know which cluster you're on, log in to the app and check the URL. If the URL starts with app-eu8.planhat.com then eu8 is your cluster.

API Access Token- Most end-points require authentication by an API Access Token that can be generated using Service Accounts under the Settings section in Planhat. Once a token is created, it will appear once and last forever. Make sure to copy and store it securely once generated.

To disable a token simply disable the Service Account, pause it, or remove the API Access Token from Service Account, the latter will permanently invalidate the token.

API Access Tokens (API keys) are static tokens that belong to a Service Account, meaning that whatever operation performed with this token, will appear as a Service Account action. It is possible to limit the access scope for an API Access Token by configuring permissions on the Service Account level.

Find more information here.

Features

Feature	Support	Notes
Backfill	✅	All-time
Incremental	❌
API reliability	🟢	Reliable

Reports detail

⬇️ Report	🔑 Incremental key	🔑 Primary key	📄 Link to API endpoint
Companies	`N/A`	`ID`	Get Companies
Conversations	`N/A`	`ID`	Get Conversations
Custom Fields	`N/A`	`ID`	Get Custom Fields
End Users	`N/A`	`ID`	Get End Users
Invoices	`N/A`	`ID`	Get Invoices
Issues	`N/A`	`ID`	Get Issues
Licenses	`N/A`	`ID`	Get Licenses
NPS	`N/A`	`ID`	Get NPS
Opportunities	`N/A`	`ID`	Get Oppertunities
Sales	`N/A`	`ID`	Get Sales
Tasks	`N/A`	`ID`	Get Tasks
Tickets	`N/A`	`ID`	Get Tickets
Users	`N/A`	`ID`	Get Users