← Back to Developer Center
Raw OpenAPI JSONRaw OpenAPI YAML
Swagger + search

Open API Explorer

Use this page to find the route you need by business job, object type, tag, schema, or app surface. Then inspect the full Swagger contract below.

Find by job

Search the DataSynch API by what you are trying to do

Search by route, schema, tag, object type, app surface, caller, or business job.

Open Developer Workbench
GET/api/datasynch/healthHealthGCP safeUI backed

Check DataSynch health

Confirm that the DataSynch API is responding before testing deeper workflows.

Required context
none
App surface
DataSynch → Developer Center → API Explorer
Related schema
HealthResponse
Next step
/api/datasynch/application-integration/status
GET/api/datasynch/application-integration/statusHealthGCP safeUI backed

Check GCP Application Integration readiness

Inspect safe configuration status for Application Integration execution.

Required context
project configuration
App surface
DataSynch → Integrations → Application Integration
Related schema
ApplicationIntegrationStatusResponse
Next step
/api/datasynch/integrations/profiles
GET/api/datasynch/integrations/profilesProfilesGCP safeUI backed

List integration profiles

List reusable source, processing, and outbound profiles scoped to a manifest.

Required context
manifestId
App surface
DataSynch → Profiles / Integrations
Related schema
ListIntegrationProfilesResponse
Next step
/api/datasynch/integrations/receiver
POST/api/datasynch/integrations/receiverIntegration IntakeGCP safeUI backed

Receive integration payload records

Accept normalized or semi-normalized records from GCP Application Integration, a webhook, file processor, scanner, or internal source.

Required context
companyId when enforced, workspaceId when available, manifestId, connectorId, sourceKind
App surface
DataSynch → Pipeline Composer → Intake
Related schema
IntegrationReceiverRequest
Next step
/api/datasynch/processing/normalize, /api/datasynch/master-tables/import
POST/api/datasynch/master-tables/importMaster TablesGCP safeUI backed

Import master table records

Import mapper-safe dynamic records into CRM, locations, items, inventory, or telemetry.

Required context
companyId when enforced, workspaceId when available, manifestId, targetTable, records
App surface
DataSynch → Master Tables / Import
Related schema
ImportMasterTableRecordsRequest
Next step
/api/datasynch/runs, /api/datasynch/exceptions
POST/api/datasynch/locations/importLocationsGCP safeUI backed

Import location records

Import location master data from WMS, TMS, ERP, spreadsheet, partner feed, or integration connector.

Required context
manifestId, records
App surface
DataSynch → Locations
Related schema
ImportLocationRecordsRequest
Next step
/api/datasynch/geofences, /api/datasynch/processing/normalize
POST/api/datasynch/telemetry/eventsTelemetryGCP safeUI backed

Create a telemetry event

Send one telemetry or logistics event, such as arrival, departure, in-transit, exception, or status update.

Required context
manifestId, eventTime or source timestamp, eventCode or eventDescription
App surface
DataSynch → Telemetry
Related schema
CreateTelemetryEventRequest
Next step
/api/datasynch/geofence-events, /api/datasynch/exceptions
POST/api/datasynch/processing/normalizeProcessingGCP safeUI backed

Normalize records

Normalize mapper-safe records and infer fields before importing or evaluating rules.

Required context
manifestId, records
App surface
DataSynch → Processing
Related schema
NormalizeRecordsRequest
Next step
/api/datasynch/processing/map-fields, /api/datasynch/xref/evaluate
POST/api/datasynch/xref/evaluateXREFGCP safeUI backed

Evaluate XREF rules

Evaluate cross-reference rules against incoming records before import or dispatch.

Required context
manifestId, records, rules or profileId
App surface
DataSynch → XREF
Related schema
EvaluateXrefRulesRequest
Next step
/api/datasynch/master-tables/import, /api/datasynch/exceptions
POST/api/datasynch/geofencesGeofencesGCP safeUI backed

Create a geofence

Create a point-radius or polygon geofence tied to a manifest and optionally a location.

Required context
manifestId, name, geometryType
App surface
DataSynch → Geofences
Related schema
CreateGeofenceRequest
Next step
/api/datasynch/geofence-events, /api/datasynch/notification-dispatch
POST/api/datasynch/geofence-eventsGeofencesGCP safeUI backed

Create a geofence event

Record an enter, exit, dwell, wrong-site, or nearby event for a subject and geofence.

Required context
manifestId, eventType, subjectId or asset reference
App surface
DataSynch → Geofence Events
Related schema
CreateGeofenceEventRequest
Next step
/api/datasynch/exceptions, /api/datasynch/notification-dispatch
POST/api/datasynch/notification-dispatchDispatchGCP safeUI backed

Dispatch a notification

Queue or send internal notification, email, webhook, Slack message, or CSV export request.

Required context
manifestId, dispatchType, payload
App surface
DataSynch → Dispatch
Related schema
DispatchRequest
Next step
/api/datasynch/dispatch/logs
GET/api/datasynch/runsRunsGCP safeUI backed

List integration runs

List run logs for operational traceability and support.

Required context
manifestId
App surface
DataSynch → Runs / Telemetry Dashboard
Related schema
ListRunsResponse
Next step
/api/datasynch/runs/{runId}

Interactive Swagger documentation

Filter, inspect schemas, view operation IDs, and try requests against the DataSynch OpenAPI surface.

Raw OpenAPI JSONRaw OpenAPI YAML
Keep exploring

Explore solutions and related documentation

The API contract is one entry point. These links make it easy to move from route details back to solution pages, examples, the workbench, and the main Atlasemoji surfaces.

Back to map
Start here

DataSynch Developer Center

Guided docs, API Explorer, Workbench, quick starts, examples, GCP, and non-GCP integration notes.

Swagger

Searchable API Explorer

Find routes by job, tag, schema, endpoint, or app surface.

Build

Developer Workbench

Run guided workflows for imports, XREF, geofences, telemetry, dispatch, and run logs.

Examples

API Examples

Copy known-good request bodies for DataSynch API testing and partner integration.

Atlas DataSynch

Map-aware operating hub for locations, partner data, Xref, telemetry, inventory, exceptions, and normalized workflow records.

Geofencing

Create radius or polygon boundaries that turn movement, scans, arrivals, exits, and dwell time into operational events.

CRM

Connect accounts, contacts, partners, campaigns, field coverage, support activity, and customer sites to operational context.

Inventory & Items

Track products, parts, consignment stock, truck inventory, store inventory, and high-value items by location or movement.

Handheld Scanner

Use Android/mobile scanning for pick-pack, scan-n-pack, proof capture, proximity checks, and field-event workflows.

Xref / Partner Mapping

Convert partner, customer, ERP, EDI, spreadsheet, or app-specific codes into usable internal values.

Atlas Intercept

Route alerts, webhooks, exceptions, and downstream actions when operational events need a response.

API & Integration Hub

RESTful access for GCP, webhooks, EDI, EDIFACT, cXML, spreadsheets, apps, and partner workflows.

EDI, EDIFACT & cXML

Consume or issue structured business documents and connect them to map-aware workflows.

Travel & Routing

Build route visuals for field movement, customer visits, trips, vessels, aircraft, and operational planning.

Learning & Help

Quick starts, field guides, help files, API explainers, and implementation notes for business and technical users.

    Atlas DataSynch API Explorer • Atlasemoji