Version 0.0.4


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


API reliability🟒Reliable

Reports detail

⬇️ ReportπŸ”‘ Incremental keyπŸ”‘ Primary keyπŸ“„ Link to API endpoint
CompaniesN/AIDGet Companies
ConversationsN/AIDGet Conversations
Custom FieldsN/AIDGet Custom Fields
End UsersN/AIDGet End Users
InvoicesN/AIDGet Invoices
IssuesN/AIDGet Issues
LicensesN/AIDGet Licenses
OpportunitiesN/AIDGet Oppertunities
SalesN/AIDGet Sales
TasksN/AIDGet Tasks
TicketsN/AIDGet Tickets
UsersN/AIDGet Users