Skip to main content

Planhat (Source)

Introduction​

The Planhat source connector lets you connect to the Planhat API using an API key.

Status​

This connector is currently in development:

  • Connection/authentication (API key validation) is implemented.
  • Schema discovery and data extraction are not yet available.

Setup​

Prerequisites​

  • A Planhat account with access to generate an API key.
  • Network access to https://api.planhat.com.

Create an API key in Planhat​

In Planhat, generate an API key (sometimes labeled as an API token). Keep it secure—this key grants access to your Planhat data via the API.

Authentication​

This connector authenticates using an API key sent in the X-API-Key header.

During connection testing, the connector validates credentials by calling:

  • GET https://api.planhat.com/companies?limit=1

Configuration​

FieldTypeRequiredDescription
api_keystring✅Your Planhat API key used to authenticate requests to the Planhat API.

Streams​

No streams are currently available. Catalog discovery returns an empty catalog, and extraction is not yet implemented.

Limitations​

  • Incremental sync is not supported yet.
  • No objects/streams are exposed yet (companies, users, etc. will be added in a future release).