How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hightouch Syncs API

Syncs, sync runs, sync sequences and their triggers.

Hightouch Syncs API is one of 8 APIs that Hightouch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Syncs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 9 operations across 7 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.hightouch.com/api/v1.

9 operations 7 paths 21 schemas 4 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.hightouch.com/api/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Hightouch Syncs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 4 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Syncs 9
GET
/syncs/{syncId}
Get Sync
GetSync 1 param → 200401404
PATCH
/syncs/{syncId}
Update Sync
UpdateSync 1 param body → 200401404422500
GET
/syncs
List Syncs
ListSync 7 params → 200400401422
POST
/syncs
Create Sync
CreateSync body → 200401409422500
GET
/syncs/{syncId}/runs
List Sync Runs
ListSyncRuns 8 params → 200400401422
POST
/syncs/{syncId}/trigger
Trigger Sync
TriggerRun 1 param body → 200400401422
POST
/syncs/trigger
Trigger Sync From ID or Slug
TriggerRunCustom body → 200400401422
POST
/sync-sequences/{syncSequenceId}/trigger
Trigger Sync sequence
TriggerSequenceRun 1 param → 200400401422
GET
/sync-sequences/runs/{syncSequenceRunId}
Sync sequence status
GetSyncSequenceRun 1 param → 200400401422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Sync (16 properties), SyncRun (11 properties), Record_Day.boolean-or-undefined_ (7 properties), SyncCreate (6 properties). Each schema is shown below with its type and property counts.

VisualCronSchedule
object
1 property 1 required
CronSchedule
object
1 property 1 required
InternalServerError
string
Sync
object
Syncs define how data from models are mapped to destinations. Each time a sync runs, Hightouch calculates the rows that have changed since the last run, and sy…
16 properties 16 required
TriggerRunCustomInput
object
The input of a trigger action to run syncs based on sync ID, slug or other filters
5 properties
TriggerRunOutput
object
The output of a trigger action to run syncs
1 property 1 required
SyncSequenceRequestStatus
string
SyncRunStatus
string
The status of sync runs
ValidateErrorJSON
object
2 properties 2 required
SyncCreate
object
The input for creating a Sync
6 properties 6 required
SyncStatus
string
SyncStatus
SyncRun
object
11 properties 10 required
SyncUpdate
object
The input for updating a Sync
3 properties
TriggerSequenceRunOutput
object
The output of a trigger action to run sync sequences
1 property 1 required
Record_Day.boolean-or-undefined_
object
Construct a type with a set of properties K of type T
7 properties
IntervalUnit
string
TriggerRunInput
object
The input of a trigger action to run syncs
3 properties
IntervalSchedule
object
1 property 1 required
SyncSequenceStatusOutput
object
The status of a given sync sequence run at both a high level and the individual sync-run level.
3 properties 3 required
DBTSchedule
object
2 properties 2 required
Interval
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hightouch-syncs-api-openapi.yml Raw ↑

Other APIs Hightouch publishes across the network.

Hightouch Sources API
Hightouch Models API
Hightouch Destinations API
Hightouch Campaigns API
Hightouch AI Decisioning API
Hightouch Events API
Hightouch Identity Resolution API
Where this information came from

This is an independent, third-party profile of Hightouch Syncs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.