Get returns one sync by id.

Get returns one sync by id. It is org-scoped: an id belonging to another tenant is the same 404 an unknown id gives, so a probe learns nothing about what…

GET /v1/sync/{id}

Sync → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/sync/{id}`
Method	`GET`
Operation	`get_sync_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Get returns one sync by id. It is org-scoped: an id belonging to another tenant is the same 404 an unknown id gives, so a probe learns nothing about what exists.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the sync to act on, from the path.

Response

Status	Body	Meaning
`200`	syncView	ok

200 body — 15 fields.

Field	In	Type	Always	Description
`actor`	body	string	—	Actor is the identity a reconcile writes AS.
`createdAt`	body	string	—	CreatedAt is when the link was first declared, RFC3339 in UTC.
`direction`	body	string	—	Direction is which way work flows: "both", "pull" (target ← source), "push" (source → target), or "off" — which keeps the link declared and moves nothing.
`id`	body	string	—	ID is the link's handle, derived from its source and target — which is what makes re-declaring the same pair an update rather than a duplicate.
`kind`	body	string	—	Kind is what is being synced.
`source`	body	endpointView	—
`source.connector`	body	string	—	Connector names a connected account from the org's connector registry, when the endpoint reaches its provider through one.
`source.locator`	body	string	—	Locator addresses the thing INSIDE that provider, in the provider's own terms — an https clone URL for a hosted forge, a bare repository name for hanzo-git.
`source.provider`	body	string	—	Provider is the concrete integration: "github", "gitlab" or "hanzo-git".
`target`	body	endpointView	—
`target.connector`	body	string	—	Connector names a connected account from the org's connector registry, when the endpoint reaches its provider through one.
`target.locator`	body	string	—	Locator addresses the thing INSIDE that provider, in the provider's own terms — an https clone URL for a hosted forge, a bare repository name for hanzo-git.
`target.provider`	body	string	—	Provider is the concrete integration: "github", "gitlab" or "hanzo-git".
`trigger`	body	string	—	Trigger is what starts a reconcile: "webhook" (the provider tells us), "poll" (we ask on a schedule), or "manual" (only an explicit call).
`updatedAt`	body	string	—	UpdatedAt is bumped by every reconcile, so it reads as the LAST-SYNCED time rather than the last edit.

Failure carries the platform error shape — see Errors.

Examples

hanzo sync get <id>

import { Configuration, SyncApi } from 'hanzoai';

const api = new SyncApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSyncById({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SyncApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SyncApi(client).get_sync_by_id(id='id')

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.SyncAPI.GetSyncById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, sync_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = sync_api::get_sync_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SyncApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new SyncApi(client).getSyncById();

curl https://api.hanzo.ai/v1/sync/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool sync, op get_sync_by_id — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "sync",
         "arguments": {
           "op": "get_sync_by_id",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

Sync API · All Hanzo APIs · Interactive reference

Get returns one sync by id.

Request

Response

Examples

On this page