/
CH
chift
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Accounting
57
Banking
6
Connections
6
Connectors
1
Consumers
12
Datalayer
3
Datastores
1
eCommerce
14
General
1
Insights
3
Integrations
3
Invoicing
20
Issues
3
MCP
1
Payment
7
Point of Sale
18
Property Management System
11
Spend Management
24
Syncs
29
get
/syncs
Get syncs
post
/syncs
Create sync
get
/syncs/{syncid}
Get sync
get
/syncs/{syncid}/flows/{flowid}/settings
Settings this flow accepts when you run it
post
/syncs/{syncid}/flows/{flowid}/execute
Run a flow now
post
/syncs/{syncid}/flows/{flowid}/event
Send a custom event for a specific flow (deprecated)
get
/syncs/{syncid}/executions
Get executions for a sync
get
/syncs/{syncid}/flows/{flowid}/executions/{executionid}
Get execution details
patch
/consumers/{consumer_id}/syncs/{syncid}
Update flow mappings for a specific consumer
post
/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable
Enable a flow for a specific consumer
post
/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/disable
Disable a flow for a specific consumer
patch
/consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}
Update flow settings for a specific consumer
get
/syncs/{syncid}/capabilities
Capabilities of an agentic sync, and which your consumers are offered
put
/syncs/{syncid}/capabilities
Choose which capabilities your consumers are offered
get
/syncs/{syncid}/integrations
Integrations a consumer can connect to an agentic sync
get
/consumers/{consumer_id}/syncs/{syncid}/capabilities
A consumer's setup of an agentic sync
put
/consumers/{consumer_id}/syncs/{syncid}/capabilities
Choose a consumer's capabilities and modes
get
/consumers/{consumer_id}/syncs/{syncid}/journey
Where a consumer stands in setting up an agentic sync
get
/consumers/{consumer_id}/syncs/{syncid}/questions
Questions a consumer's capabilities ask, with their answers
patch
/consumers/{consumer_id}/syncs/{syncid}/questions
Answer a consumer's questions
get
/consumers/{consumer_id}/syncs/{syncid}/mappings
The mapping tables a consumer's sync needs
get
/consumers/{consumer_id}/syncs/{syncid}/mappings/{table_key}
One mapping table of a consumer: its rows, values and candidates
post
/consumers/{consumer_id}/syncs/{syncid}/ai-fill
Fill a consumer's mapping values
get
/consumers/{consumer_id}/syncs/{syncid}/previews
A consumer's recent previews
post
/consumers/{consumer_id}/syncs/{syncid}/previews
Preview what a consumer's sync would create
get
/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}
One preview: where it stands, what it would create and what would fail
get
/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects
The objects a preview would create
get
/consumers/{consumer_id}/syncs/{syncid}/objects/{kind}
The objects of one type a consumer's sync handled
get
/consumers/{consumer_id}/syncs/{syncid}/objects/{kind}/{object_id}
What a consumer's sync did to one object
Webhooks
7
Syncs
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to One preview: where it stands, what it would create and what would fail
get
/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}
Nov 3, 2026
020884969534
Revision changes
info
endpoint added