Hightouch

Hightouch Syncs API

Syncs, sync runs, sync sequences and their triggers.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /syncs/{syncId} Look up a sync · Get Sync #
Ask an LLM
“How do I see the mapping and schedule of one sync by its ID?”
“Is a particular Hightouch sync currently disabled?”
Tell an agent
Get sync {syncId}.
Show the schedule and mappings of sync {syncId}.
PATCH /syncs/{syncId} Change a sync's schedule, mapping or status · Update Sync #
Ask an LLM
“Can I pause an existing sync by disabling it?”
“How do I change the schedule on a sync I already set up?”
Tell an agent
Disable sync {syncId} ({disabled}).
Change the schedule of sync {syncId} to {schedule}.
GET /syncs List syncs in the workspace · List Syncs #
Ask an LLM
“Which syncs are set up in my workspace?”
“Can I list only the syncs that use a particular model?”
Tell an agent
List all syncs in my workspace.
List the syncs built on model {modelId}.
POST /syncs Create a sync from a model to a destination · Create Sync #
Ask an LLM
“How do I set up a new sync that sends a model's rows to a destination?”
“Can I create a sync in a disabled state and turn it on later?”
Tell an agent
Create sync {slug} from model {modelId} to destination {destinationId} with configuration {configuration}, schedule {schedule}, disabled {disabled}.
Set up a new sync {slug} sending model {modelId} to {destinationId} on schedule {schedule}, mapping {configuration}, disabled={disabled}.
GET /syncs/{syncId}/runs List the run history of a sync · List Sync Runs #
Ask an LLM
“Did my sync run successfully in the last hour?”
“How do I see the past runs of a specific sync?”
Tell an agent
List the runs of sync {syncId}.
Show runs of sync {syncId} started within the last {within} minutes.
POST /syncs/{syncId}/trigger Run a sync by its ID · Trigger Sync #
Ask an LLM
“How do I kick off a sync run immediately using the sync's ID in the path?”
“Can I force a full resync that ignores previously synced rows?”
Tell an agent
Trigger sync {syncId} now.
Run a full resync of sync {syncId} ({fullResync}).
POST /syncs/trigger Run a sync by its slug or ID globally · Trigger Sync From ID or Slug #
Ask an LLM
“Can I trigger a sync using its slug instead of its numeric ID?”
“Is there a global trigger endpoint that takes the sync identifier in the body?”
Tell an agent
Trigger the sync with slug {syncSlug}.
Run the sync identified by {syncId} through the global trigger endpoint.

Documentation

📖
Documentation
https://hightouch.com/docs
📖
APIReference
https://hightouch.com/docs/api-reference
📖
GettingStarted
https://hightouch.com/docs/getting-started/welcome

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hightouch/refs/heads/main/openapi/hightouch-syncs-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/hightouch/refs/heads/main/overlays/hightouch-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hightouch-syncs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hightouch-syncs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Hightouch Syncs API
  version: 1.0.0
  description: Hightouch Public Rest API to access syncs, models, sources and destinations
  contact:
    name: Hightouch
    url: https://hightouch.com
servers:
- url: https://api.hightouch.com/api/v1
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hightouch/refs/heads/main/openapi/hightouch-syncs-api-openapi.yml