# Sync

Sync configurations define automated data synchronization mappings between CaraerObjects. A Sync specifies how property values from source Records should be mapped to target Records, enabling automated data flow between different object types. Syncs use Mappings that define source and target properties, allowing data to be copied, transformed, or synchronized when source Records are created or updated. Syncs are used for data integration, automation workflows, and keeping related data in sync across the platform. They enable scenarios like automatically creating a Company Record when a User Record is created, or syncing Candidate data to an external system. Syncs support complex mapping rules and can trigger on various Record events.

## Get a sync

 - [GET /api/v2/sync/{uuid}](https://developer.caraer.com/apis/sync/getsync.md): Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details.

## Update a sync

 - [PUT /api/v2/sync/{uuid}](https://developer.caraer.com/apis/sync/updatesync.md): Updates an existing sync. Returns a UpdateResponse containing the updated sync details.

## Delete a sync

 - [DELETE /api/v2/sync/{uuid}](https://developer.caraer.com/apis/sync/deletesync.md): Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details.

## Fetch paginated syncs

 - [POST /api/v2/sync/index](https://developer.caraer.com/apis/sync/getsyncs.md): Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria.

## Create a sync

 - [POST /api/v2/sync/](https://developer.caraer.com/apis/sync/createsync.md): Creates a new sync. Returns a CreateResponse containing the created sync details.