Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hightouch Syncs API

Data syncs and runs

Hightouch Syncs API is one of 4 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, a getting-started guide, and an API reference.

This API exposes 5 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version v1.

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

5 operations 4 paths 1 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Syncs 5

Data syncs and runs

GET
/api/v1/syncs
List syncs
listSyncs → 200
POST
/api/v1/syncs
Create a sync
createSync body → 201
GET
/api/v1/syncs/{id}
Get a sync
getSync 1 param → 200
POST
/api/v1/syncs/{id}/trigger
Trigger a sync run
triggerSync 1 param → 200
GET
/api/v1/syncs/{id}/runs
List sync runs
listSyncRuns 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Sync (5 properties). Each schema is shown below with its type and property counts.

Sync
object
5 properties

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 Destinations API
Hightouch Models API
Hightouch Sources API