Search documentation...

K

Using API

Overview

Hightouch exposes a REST API that lets users interact with resources like syncs, models, sources and destinations.

Though the REST API is open to all Hightouch users, we aim to build features so you don't need to rely on it directly. For example, Git sync lets you manage orchestration programmatically. If you're looking to create a custom destination, it's best to use the HTTP Request destination as your base. If you find you still need to use the REST API directly, about your use case.

To start using the API, you must first create and retrieve an API key from your workspace.

Create an API key

  1. From the API keys tab on the Settings page, select Add API key.
  2. Enter a descriptive Name for your key.
  3. Copy your API key and store it in a safe location. The key will only be displayed once.
  4. Click Create API key.

Once you have an API key, you can follow the API Reference documentation to start using the API.

    Need help?

    Our team is relentlessly focused on your success. We're ready to jump on a call to help unblock you.

    • Connection issues with your data warehouse?
    • Confusing API responses from destination systems?
    • Unsupported destination objects or modes?
    • Help with complex SQL queries?

    Feature Requests?

    If you see something that's missing from our app, let us know and we'll work with you to build it!

    We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data.

On this page

OverviewCreate an API key

Was this page helpful?